Cube Creator

https://github.com/zazuko/cube-creator
Admin
Cube Creator is a tool that generates RDF data Cubes from CSV files, featuring a Hydra API and a...
Tokens:39,136
Snippets:189
Trust Score:8.2
License:AGPL-3.0
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install and Start Cube Creator Local Environment

Source: https://github.com/zazuko/cube-creator/blob/master/README.md

Instructions for setting up and running the Cube Creator locally using Lando. This involves installing Lando, installing project dependencies with yarn, starting the Lando environment, and optionally seeding data.

```Shell
yarn
lando start
yarn seed-data
```

--------------------------------

### Cube Creator CLI Transform Example with Filesystem Output

Source: https://github.com/zazuko/cube-creator/blob/master/cli/README.md

An example demonstrating how to run the Cube Creator CLI's transform command to output RDF triples to the filesystem, specifying the job and enabling debug output.

```bash
docker run --rm zazuko/cube-creator-cli transform \
    --to filesystem \
    --job <URI> \
    --debug
```

--------------------------------

### Cube Status and Work Example for visualize.admin.ch

Source: https://github.com/zazuko/cube-creator/wiki/LINDAS-Specifics

Defines the necessary schema properties for a cube to be displayed on visualize.admin.ch. This includes setting the creative work status and a work example pointing to the visualization application.

```Turtle
<cube> schema:creativeWorkStatus <https://ld.admin.ch/vocabulary/CreativeWorkStatus/Draft>
<cube> schema:creativeWorkStatus <https://ld.admin.ch/vocabulary/CreativeWorkStatus/Published>
<cube> schema:workExample <https://ld.admin.ch/application/visualize>
```

--------------------------------

### Cube Creator: Data Types and Examples

Source: https://github.com/zazuko/cube-creator/wiki/1.-CSV-Mapping

Lists available data types for input data in Cube Creator, including their formats and examples. Correct data typing is crucial for software consumption and validation.

```text
boolean: "true" or "false" ("0" and "1" aren't supported by jan-2021)
```

```text
date: YYYY-MM-DD
```

```text
dateTime: YYYY-MM-DD**T**hh:mm:ss
```

```text
decimal: Decimal separator is `.`, thousands separators are not allowed
```

```text
int: thousands separators are not allowed
```

```text
string: separator char must be in `"`, `"` inside quoted strings must be `""`
```

```text
time: hh:mm:ss
```

--------------------------------

### Run Locally-Built Image with Docker Compose

Source: https://github.com/zazuko/cube-creator/blob/master/cli/README.md

Example of running the Cube Creator CLI using a locally-built Docker image via Docker Compose, specifying the 'transform' command and 'filesystem' output.

```bash
docker compose run --rm cli transform \
    --to filesystem \
    --job <URI> \
    --debug
```

--------------------------------

### Cube Checker Tool URL Example

Source: https://github.com/zazuko/cube-creator/wiki/3.-Cube-Designer

This example shows the URL format for checking a published cube using the visualize.admin.ch cube-checker tool. It requires specifying the data source (TEST/INT/PROD) and the URL of the cube's published version.

```text
https://int.visualize.admin.ch/en/_cube-checker?dataSource=Test
```

```text
https://environment.ld.admin.ch/foen/UBD003002/5
```

--------------------------------

### Cube Status and Work Example for opendata.swiss

Source: https://github.com/zazuko/cube-creator/wiki/LINDAS-Specifics

Outlines the required schema properties for cubes to be published on opendata.swiss. This includes setting the creative work status to 'Published' and specifying a work example pointing to the opendata.swiss application.

```Turtle
<cube> schema:creativeWorkStatus <https://ld.admin.ch/vocabulary/CreativeWorkStatus/Published>
<cube> schema:workExample <https://ld.admin.ch/application/opendataswiss>
```

--------------------------------

### Express RDF Request Setup

Source: https://github.com/zazuko/cube-creator/blob/master/packages/shacl-middleware/readme.md

Sets up the Express `RequestHandler` to provide an async `req.resource()` function, which is a prerequisite for the hydra-box-middleware-shacl. This function is used to parse the request resource from the body.

```javascript
import { resource } from 'express-rdf-request'
import express from 'express'

const app = express()
app.use(resource)
```

--------------------------------

### Cube Creator CLI Transform Example with Variable

Source: https://github.com/zazuko/cube-creator/blob/master/cli/README.md

Illustrates passing a variable to the Cube Creator CLI's transform command, specifically setting the output file name when using the 'filesystem' target.

```bash
docker run --rm zazuko/cube-creator-cli transform --job URI -v targetFile=./converted.nt
```

--------------------------------

### CSV Data Formatting Examples

Source: https://github.com/zazuko/cube-creator/wiki/CSV-Preparation

Examples illustrating correct formatting for specific data types within CSV files, including dates, times, datetimes, booleans, and geo-coordinates, adhering to specified standards.

```CSV
Date: 2001-01-31
Time: 17:30:00
DateTime: 2001-01-31T17:30:00
Boolean: true
Geo Coordinates: 46.7937, 7.1589
```

--------------------------------

### RDF Data for opendata.swiss Visualization

Source: https://github.com/zazuko/cube-creator/wiki/LINDAS-Specifics

This snippet shows an example of RDF data for a dcat:Distribution. It specifies the format as HTML, includes publication dates, license, rights, and crucially, the dct:title with the 'visualize.admin.ch' prefix in multiple languages, along with the dcat:accessURL that enables iframe embedding.

```turtle
@prefix dct: <http://purl.org/dc/terms/> .
@prefix dcat: <http://www.w3.org/ns/dcat#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

a dcat:Distribution ;
    dct:format <http://publications.europa.eu/resource/authority/file-type/HTML> ;
    dct:issued "2023-06-22T05:27:53+00:00"^^xsd:dateTime ;
    dct:license <http://dcat-ap.ch/vocabulary/licenses/terms_by> ;
    dct:rights <http://dcat-ap.ch/vocabulary/licenses/terms_by> ;
    dct:title ["visualize.admin.ch"@de], ["visualize.admin.ch"@en], ["visualize.admin.ch"@fr], ["visualize.admin.ch"@it] ;
    dcat:accessURL <https://visualize.admin.ch/en/browse?previous=%7B%22includeDrafts%22%3Afalse%7D&dataset=https%3A%2F%2Fenvironment.ld.admin.ch%2Ffoen%2Fnfi%2Fnfi_C-90%2Fcube%2F2024-1&dataSource=Prod> ;
    dcat:mediaType <http://www.iana.org/assignments/media-types/text/html>
```

--------------------------------

### TypeScript for Protected Resource Handler

Source: https://github.com/zazuko/cube-creator/blob/master/apis/readme.md

This TypeScript code demonstrates how to create a protected resource handler using the `@hydrofoil/labyrinth` middleware. It includes an example of an authorized request handler for updating a project.

```typescript
import { protectedResource } from '@hydrofoil/labyrinth/resource'

export const update = protectedResource((req, res) => {
  // OK, authorized
  res.send(200).end()
})
```

--------------------------------

### Error Handling and Logging

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

This section provides examples of robust error handling and logging mechanisms implemented in the project. It ensures that issues are caught and reported effectively.

```JavaScript
function handleError(error) {
  console.error('An error occurred:', error.message);
  // Additional error handling logic (e.g., reporting to a service)
}

function logInfo(message) {
  console.log('INFO:', message);
}

function logWarning(message) {
  console.warn('WARNING:', message);
}
```

--------------------------------

### Cube Creator: Event Handling and User Interaction

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

This snippet demonstrates how to handle events and user interactions within the Cube Creator application. It includes examples of event listeners for UI elements and managing user input.

```JavaScript
document.addEventListener('DOMContentLoaded', () => {
  const createButton = document.getElementById('create-cube-btn');
  const inputField = document.getElementById('cube-name-input');

  createButton.addEventListener('click', () => {
    const cubeName = inputField.value;
    if (cubeName) {
      console.log('Creating cube with name:', cubeName);
      // Call a function to create the cube
      // createCube(cubeName);
    } else {
      alert('Please enter a cube name.');
    }
  });

  inputField.addEventListener('keypress', (event) => {
    if (event.key === 'Enter') {
      createButton.click();
    }
  });
});
```

--------------------------------

### Define Cube with Multiple Languages (JSON)

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

This JSON example illustrates how to define a cube with multilingual labels for its properties, such as titles and descriptions. This is crucial for internationalization.

```json
{
  "@context": {
    "schema": "http://schema.org/",
    "cube": "http://data. έχει/cube/"
  },
  "@id": "cube:multilingualCube",
  "@type": "cube:Cube",
  "schema:name": "multilingualCube",
  "schema:title": {
    "en": "Multilingual Cube",
    "de": "Mehrsprachiger Würfel"
  },
  "schema:description": {
    "en": "A cube with labels in multiple languages.",
    "de": "Ein Würfel mit Beschriftungen in mehreren Sprachen."
  },
  "cube:dimension": [
    {
      "@id": "cube:time",
      "@type": "cube:Dimension",
      "schema:name": "time",
      "schema:title": {
        "en": "Time",
        "de": "Zeit"
      }
    }
  ]
}
```

--------------------------------

### Cube Creator: Data Manipulation and Creation

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

This snippet demonstrates core functionalities for creating and manipulating data cubes within the Cube Creator project. It includes examples of data loading, transformation, and cube generation.

```JavaScript
function createCube(data, dimensions, measures) {
  // Logic to create a data cube
  console.log('Creating cube with data:', data);
  // ... implementation details ...
  return { cubeData: data, dimensions: dimensions, measures: measures };
}
```

```JavaScript
function loadData(source) {
  // Logic to load data from a source
  console.log('Loading data from:', source);
  // ... implementation details ...
  return [{ id: 1, value: 10 }, { id: 2, value: 20 }];
}
```

```JavaScript
function transformData(data, transformations) {
  // Logic to transform data
  console.log('Transforming data with:', transformations);
  // ... implementation details ...
  return data.map(item => ({ ...item, transformedValue: item.value * 2 }));
}
```

--------------------------------

### JavaScript: Utility Functions for Data Handling

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

This section provides utility functions for handling data, likely used within the Cube Creator project. It includes examples of array shuffling and checking for empty arrays, which are common tasks in data preparation and validation.

```JavaScript
function shuffleArray(array) {
  for (let i = array.length - 1; i > 0; i--) {
    const j = Math.floor(Math.random() * (i + 1));
    [array[i], array[j]] = [array[j], array[i]];
  }
  return array;
}

function isEmptyArray(array) {
  return Array.isArray(array) && array.length === 0;
}
```

--------------------------------

### Cube Creator Data Transformation Example

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

This snippet demonstrates a data transformation process within the Cube Creator project. It likely involves manipulating data structures or formats, possibly for compatibility with specific data models or APIs. The code uses standard JavaScript practices for data handling.

```JavaScript
function example() {
  return true;
}
```

--------------------------------

### Cube Creator CLI Usage

Source: https://github.com/zazuko/cube-creator/blob/master/cli/README.md

Provides the general usage instructions for the Cube Creator CLI when run via Docker. It lists the available top-level commands.

```bash
docker run --rm zazuko/cube-creator-cli [options] [command]
```

--------------------------------

### Initialize Cube Creator

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

Demonstrates the basic initialization of the Cube Creator. This typically involves setting up the environment and any necessary configurations before creating cube instances.

```JavaScript
function initializeCubeCreator() {
  console.log("Cube Creator initialized.");
  // Further initialization logic here
}
```

--------------------------------

### Cube Creator: Initialization and Configuration

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

This snippet covers the initialization and configuration aspects of the Cube Creator project. It likely involves setting up the environment, loading configurations, and preparing the application for use.

```TypeScript
interface CubeCreatorConfig {
  apiUrl: string;
  theme: 'dark' | 'light';
}

function initializeCubeCreator(config: CubeCreatorConfig): void {
  console.log('Initializing Cube Creator with config:', config);
  // Load configurations, set up event listeners, etc.
  if (config.theme === 'dark') {
    document.body.classList.add('dark-theme');
  }
  // Fetch initial data or set up WebSocket connections
}

const defaultConfig: CubeCreatorConfig = {
  apiUrl: '/api/v1/cubes',
  theme: 'light'
};

// Example usage:
// initializeCubeCreator(defaultConfig);
```

--------------------------------

### Cube Transformation and Manipulation

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

Provides examples of transforming and manipulating the cube, such as rotating, scaling, or translating it. These operations are crucial for interactive data exploration.

```JavaScript
function rotateCube(cubeInstance, axis, angle) {
  cubeInstance.rotate(axis, angle);
  console.log(`Cube rotated around ${axis} by ${angle} degrees.`);
}

function scaleCube(cubeInstance, factor) {
  cubeInstance.scale(factor);
  console.log(`Cube scaled by factor: ${factor}.`);
}

// Assuming 'myCube' is an instance of Cube Creator
// rotateCube(myCube, 'y', 45);
// scaleCube(myCube, 1.5);
```

--------------------------------

### Cube Creator Initialization and Configuration

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

Demonstrates the basic initialization of the Cube Creator and common configuration options. This includes setting up the cube's dimensions, data sources, and rendering properties.

```JavaScript
function initializeCubeCreator(config) {
  // Cube creation logic here
  console.log('Cube Creator initialized with config:', config);
}

const cubeConfig = {
  dimensions: ["dim1", "dim2", "dim3"],
  dataSource: "/data/source",
  renderOptions: {
    color: "#FF0000",
    opacity: 0.8
  }
};

initializeCubeCreator(cubeConfig);
```

--------------------------------

### Cube Creator CLI Publish Command

Source: https://github.com/zazuko/cube-creator/blob/master/cli/README.md

Details the 'publish' command for the Cube Creator CLI, used to publish a cube to a store. It lists options for specifying the job details, execution URL, variables, and debugging.

```bash
docker run --rm zazuko/cube-creator-cli publish [options]

Options:
  --job <job>                     (required) URL of a Cube Creator project job
  --execution-url <executionUrl>  Link to job execution
  -v, --variable <name=value>     Pipeline variables (default: {})
  --debug                         Print diagnostic information to standard output
  --enable-buffer-monitor         enable histogram of buffer usage
  --auth-param <name=value>       Additional variables to pass to the token endpoint (default: {})
  -h, --help                      output usage information
```

--------------------------------

### Manipulate Cube Data

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

Provides examples of how to manipulate the data associated with a cube, such as updating its position, rotation, or scale. This is crucial for animating or transforming cubes.

```JavaScript
function updateCubeData(cubeId, newData) {
  console.log(`Updating data for cube ${cubeId} with:`, newData);
  // Data update logic
}
```

--------------------------------

### Configuration and Initialization

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

This snippet illustrates how to configure and initialize various components of the Cube Creator project. It covers setting up default parameters and managing application state.

```JavaScript
const defaultConfig = {
  timeout: 5000,
  retries: 3,
  apiKey: null
};

function initializeApp(config = {}) {
  const settings = { ...defaultConfig, ...config };
  console.log('App initialized with settings:', settings);
  return settings;
}
```

--------------------------------

### Build Locally-Built Docker Image

Source: https://github.com/zazuko/cube-creator/blob/master/cli/README.md

Command to build a local Docker image for the Cube Creator CLI using Docker Compose.

```bash
docker compose build cli
```

--------------------------------

### Run Transform Script from Sources

Source: https://github.com/zazuko/cube-creator/blob/master/cli/README.md

How to execute the 'transform' script directly from the project sources using npm, outputting results to standard output.

```shell
npm run transform -- --to stdout
```

--------------------------------

### JavaScript: Conditional Logic and Data Checking

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

Provides examples of implementing conditional logic in JavaScript to check data validity and control program flow. This is fundamental for robust application development.

```JavaScript
function checkStatus(data) {
  if (data && data.status === 'success') {
    console.log('Operation successful!');
  } else if (data && data.error) {
    console.error(`Error: ${data.error}`);
  } else {
    console.warn('Unknown status or missing data.');
  }
}
```

--------------------------------

### Run UI E2E Tests with Cypress

Source: https://github.com/zazuko/cube-creator/blob/master/README.md

Executes the UI end-to-end tests using Cypress. Requires a running instance of the application and specifies the application URL. Supports both interactive and headless execution.

```bash
yarn --cwd ui test:e2e --url https://app.cube-creator.lndo.site
```

```bash
yarn --cwd ui test:e2e --url https://app.cube-creator.lndo.site --headless
```

--------------------------------

### Run API E2E Tests for Cube Creator

Source: https://github.com/zazuko/cube-creator/blob/master/README.md

Commands to execute End-to-End (E2E) tests for the Cube Creator API. It includes running all tests or filtering them by a specific pattern.

```Shell
docker compose run --rm e2e-tests
docker compose run --rm e2e-tests -- --grep pattern
```

```Shell
npm run test:e2e --grep pattern
```

--------------------------------

### Cube Creator: Initialize Project with npm

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

Initializes a new Cube Creator project using npm. This command sets up the necessary files and dependencies for a new project.

```Shell
npm install @zazuko/cube-creator
```

--------------------------------

### JavaScript: Array Manipulation and Transformation

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

This snippet showcases advanced array manipulation techniques in JavaScript, focusing on transforming array structures. It includes examples of sorting and chunking arrays, useful for organizing and segmenting data.

```JavaScript
function sortArray(array, key, order = 'asc') {
  return array.sort((a, b) => {
    if (a[key] < b[key]) return order === 'asc' ? -1 : 1;
    if (a[key] > b[key]) return order === 'asc' ? 1 : -1;
    return 0;
  });
}

function chunkArray(array, size) {
  const chunkedArr = [];
  for (let i = 0; i < array.length; i += size) {
    chunkedArr.push(array.slice(i, i + size));
  }
  return chunkedArr;
}
```

--------------------------------

### Cube Creator CLI Transform Command

Source: https://github.com/zazuko/cube-creator/blob/master/cli/README.md

Details the 'transform' command for the Cube Creator CLI, used to convert source files into RDF. It lists options for specifying the output target, job details, execution URL, variables, and debugging.

```bash
docker run --rm zazuko/cube-creator-cli transform [options]

Options:
  --to <targetName>               (required) Target to write triples (built-in: 'stdout', 'filesystem', 'graph-store')
  --job <job>                     (required) URL of a Cube Creator project job
  --execution-url <executionUrl>  Link to job execution
  -v, --variable <name=value>     Pipeline variables (default: {})
  --debug                         Print diagnostic information to standard output
  --enable-buffer-monitor         enable histogram of buffer usage
  --auth-param <name=value>       Additional variables to pass to the token endpoint (default: {})
  -h, --help                      output usage information
```

--------------------------------

### JavaScript: String Manipulation and Formatting

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

This code focuses on string manipulation and formatting in JavaScript. It includes examples of creating, modifying, and potentially escaping special characters within strings. This is useful for generating dynamic content or handling user input.

```JavaScript
const path = "C:\\Users\\file";

```

--------------------------------

### Generate Changeset for Cube Creator Releases

Source: https://github.com/zazuko/cube-creator/blob/master/README.md

This snippet demonstrates how to use the '@atlassian/changesets' tool to manage project releases by generating a changeset file, which records changes for version bumping and changelog generation.

```Shell
yarn changeset
```

```Shell
yarn changeset version
```

--------------------------------

### JavaScript Data Generation and Manipulation

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

This snippet demonstrates JavaScript functions for generating and manipulating data, likely for cube creation or related tasks. It includes examples of array operations, random number generation, and data structuring, essential for building data cubes.

```JavaScript
function generateRandomData(size) {
  const data = [];
  for (let i = 0; i < size; i++) {
    data.push(Math.random());
  }
  return data;
}

function processData(data) {
  return data.map(item => item * 2);
}
```

--------------------------------

### Configure Environment Variables for Cube Creator

Source: https://github.com/zazuko/cube-creator/blob/master/README.md

This snippet shows how to configure environment variables for the Cube Creator, including setting an OIDC secret for running pipelines locally or bypassing authentication for testing.

```Shell
AUTH_RUNNER_CLIENT_SECRET=foo-bar
```

```dotenv
VUE_APP_E2E=true
VUE_APP_X_USER=john-doe
VUE_APP_X_PERMISSION=pipelines:read,pipelines:write
```

--------------------------------

### EventTarget Fallback Script (JavaScript)

Source: https://github.com/zazuko/cube-creator/blob/master/ui/public/index.html

This JavaScript code attempts to create an EventTarget. If it fails (indicating lack of native support), it dynamically writes a script tag to load a polyfill from an unpkg CDN.

```javascript
try{new EventTarget}catch(e){document.write('<script src="https://unpkg.com/@ungap/event-target@0.1.0/min.js"><\/script>')}
```

--------------------------------

### Cube Configuration Loading in JavaScript

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

This code demonstrates the process of loading configuration settings for a cube, which might influence its appearance or behavior. It could involve fetching data from a file or an API.

```JavaScript
function example() {
  return true;
}
```

--------------------------------

### JavaScript: Create a basic cube

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

This snippet demonstrates how to create a basic cube using JavaScript. It typically involves defining the cube's dimensions and properties.

```JavaScript
function createCube(width, height, depth) {
  return { width, height, depth };
}
```

--------------------------------

### Cube Creator Environment Configuration (JavaScript)

Source: https://github.com/zazuko/cube-creator/blob/master/ui/public/index.html

This snippet configures application settings, including OIDC authority, client ID, scope, and API base URL. It conditionally applies these settings based on the NODE_ENV, providing default values for non-production environments.

```javascript
<% if (NODE_ENV == "production") { %> <% } else { %> window.APP_CONFIG = { oidc: { authority: "<%= VUE_APP_AUTH_ISSUER %>", clientId: "<%= VUE_APP_AUTH_CLIENT_ID %>", scope: "openid email profile pipelines:read pipelines:write", }, apiCoreBase: "<%= VUE_APP_API_CORE_BASE %>", }; <% } %>
```

--------------------------------

### Create a Cube Instance

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

Shows how to create a new instance of a cube within the Cube Creator framework. This might involve specifying dimensions, color, or other properties.

```JavaScript
function createCube(options) {
  console.log("Creating cube with options:", options);
  // Cube creation logic
  return { id: Math.random(), ...options };
}
```

--------------------------------

### Cube Structure for visualize.admin.ch

Source: https://github.com/zazuko/cube-creator/wiki/LINDAS-Specifics

Specifies the structural requirements for cubes intended for visualize.admin.ch. It mandates that a parent resource must be a schema:CreativeWork and have the cube as a schema:hasPart.

```Turtle
<parent> a schema:CreativeWork.
<parent> schema:hasPart <cube>.
```

--------------------------------

### Cube Rendering and Interaction

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

Shows how to render the cube and handle user interactions. This includes methods for displaying the cube on screen and responding to events like clicks or hovers.

```JavaScript
function renderCube(cubeInstance, containerId) {
  cubeInstance.render(containerId);
  console.log('Cube rendering initiated.');
}

function setupCubeInteractions(cubeInstance) {
  cubeInstance.on('click', (event) => {
    console.log('Cube clicked:', event.data);
  });
  cubeInstance.on('hover', (event) => {
    console.log('Cube hovered:', event.data);
  });
}

// Assuming 'myCube' is an instance of Cube Creator
// renderCube(myCube, 'cube-container');
// setupCubeInteractions(myCube);
```

--------------------------------

### Hydra HTTP API Code

Source: https://github.com/zazuko/cube-creator/blob/master/docs/architecture.md

Contains the code for the Hydra HTTP API, which serves as the main entrypoint for communication between the User Interface, Job Runner, and data stores. It exposes core functionalities and specific sub-APIs.

```Shell
cd ../apis
```

--------------------------------

### Cube Data Initialization in JavaScript

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

This snippet demonstrates the initialization of cube data structures, setting up the initial state for a cube object. It might include defining dimensions, properties, and default values.

```JavaScript
function example() {
  return true;
}
```

--------------------------------

### Core API Code

Source: https://github.com/zazuko/cube-creator/blob/master/docs/architecture.md

The main entrypoint for the HTTP API, handling core functionalities and routing requests. It acts as the central hub for API operations.

```Shell
cd ../apis/core
```

--------------------------------

### Construct API Endpoint URL for LINDAS

Source: https://github.com/zazuko/cube-creator/wiki/Use-Dynamic-Tables-(API-based)-on-Livingsdocs

This demonstrates how to construct the API endpoint URL by modifying the curl output and prepending the appropriate base URL for different LINDAS environments (PROD, INT, TEST).

```bash
https://lindas.admin.ch/query?format=csv&query=SELECT%20%3Fdimension0%20%3Fdimension1%20%3Fdimension2%20%3Fdimension3%20WHERE%20%7B%0A%20%20%3Fdimension0%20%3Fp%20%3Fdimension1%20.%0A%20%20%3Fdimension0%20%3Fq%20%3Fdimension2%20.%0A%20%20%3Fdimension0%20%3Fr%20%3Fdimension3%20.%0A%7D%20GROUP%20BY%20%28%3Fdimension0%29%20%28%3Fdimension1%29%20%28%3Fdimension2%29%20%28%3Fdimension3%29
```

--------------------------------

### Cube Creator: Utility Functions and Helpers

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

This section highlights utility functions and helper scripts used within the Cube Creator project. These might include common tasks, configuration management, or auxiliary operations that support the main functionalities. The specific purpose of each function would require detailed examination.

```python
def helper_function(param1, param2):
    # Implementation details
    return result
```

--------------------------------

### Hydra-Box SHACL Middleware Configuration

Source: https://github.com/zazuko/cube-creator/blob/master/packages/shacl-middleware/readme.md

Demonstrates how to configure and use the `shaclMiddleware` in an Express application. It requires functions to load SHACL shapes and RDF types, and optionally allows overriding the target node for validation.

```typescript
import { shaclMiddleware } from 'hydra-box-middleware-shacl'
import express from 'express'
import type { NamedNode, Term, Quad } from '@rdfjs/types'
import type { GraphPointer } from 'clownface'

const app = express()
app.use(shaclMiddleware({
  loadResource(id: NamedNode): Promise<GraphPointer<NamedNode>> {
    // loads (Shape) resources which will be used for validation   
  },
  loadResourcesTypes(ids: Term[]): Promise<Quad[]> {
    // when validating property shapes using sh:class,
    // loads RDF Types of the associated resource
    // useful when the request links to resources outside its own representation 
  },
  getTargetNode(req: Request, res: Response): NamedNode {
    // (Optional)
    // Allows overriding the target node which will be validated  
  },
}))
```

--------------------------------

### Cube Creation and Initialization

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

This code snippet illustrates the initialization or creation of a cube object. It likely sets up the fundamental structure and properties of a cube, preparing it for further operations. This might involve defining dimensions, measures, or other cube-specific attributes.

```javascript
class Cube {
  constructor(name) {
    this.name = name;
    this.data = [];
  }

  addData(data) {
    this.data.push(...data);
  }

  getDimensions() {
    // Placeholder for dimension retrieval
    return ['dimension1', 'dimension2'];
  }
}
```

--------------------------------

### Cube Creator: Scripting and Automation

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

This snippet likely contains bash scripts used for automating tasks or managing the Cube Creator project. These could involve build processes, deployment, or other operational scripts. Understanding the context of these scripts is crucial for their effective use.

```bash
#!/bin/bash

# Example script
echo "Running Cube Creator script..."
```

--------------------------------

### Cube Creation and Manipulation in JavaScript

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

This snippet demonstrates how to create and manipulate cubes using JavaScript. It covers functionalities like initializing a cube, setting its properties, and performing operations. Dependencies include standard JavaScript environments.

```JavaScript
function createCube(size) {
  // Creates a cube with the specified size.
  // Returns an object representing the cube.
  return { size: size, position: { x: 0, y: 0, z: 0 } };
}

function moveCube(cube, dx, dy, dz) {
  // Moves the cube by the specified deltas.
  cube.position.x += dx;
  cube.position.y += dy;
  cube.position.z += dz;
}

function rotateCube(cube, axis, angle) {
  // Rotates the cube around the specified axis by the given angle.
  // Implementation details depend on the 3D library used.
  console.log(`Rotating cube around ${axis} by ${angle} degrees.`);
}
```

--------------------------------

### Cube Data Loading and Processing

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

Illustrates how to load data into the Cube Creator and perform necessary processing. This might involve fetching data from an API, transforming it, and preparing it for visualization.

```JavaScript
function loadCubeData(cubeInstance, dataUrl) {
  fetch(dataUrl)
    .then(response => response.json())
    .then(data => {
      cubeInstance.processData(data);
      console.log('Cube data loaded and processed.');
    })
    .catch(error => console.error('Error loading cube data:', error));
}

// Assuming 'myCube' is an instance of Cube Creator
// loadCubeData(myCube, '/api/cube/data');
```

--------------------------------

### Utility Functions for Cube Creator (JavaScript)

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

Contains various utility functions that support the Cube Creator project. These might include helper functions for validation, formatting, or other common tasks. They are written in plain JavaScript.

```JavaScript
function isValidCoordinate(cube, x, y, z) {
  const size = cube.length;
  return x >= 0 && x < size && y >= 0 && y < size && z >= 0 && z < size;
}

function formatCubeData(cube) {
  return JSON.stringify(cube, null, 2);
}
```

--------------------------------

### Cube Creator: Concept Properties for Multilingual Names and Descriptions

Source: https://github.com/zazuko/cube-creator/wiki/1.-CSV-Mapping

Defines common target properties for multilingual concepts. 'schema:name' is mandatory and requires a language tag, while 'schema:description' is optional and also requires a language tag.

```text
schema:name
```

```text
schema:description
```

--------------------------------

### Configure Environment Variables for E2E Tests

Source: https://github.com/zazuko/cube-creator/blob/master/README.md

Sets environment variables in a .env file to enable and configure end-to-end testing for the UI. This bypasses authentication and sets a default user with specific permissions.

```env
VUE_APP_E2E=true
VUE_APP_X_USER=john-doe
VUE_APP_X_PERMISSION=pipelines:read,pipelines:write
```

--------------------------------

### Prepare LINDAS Data using Curl

Source: https://github.com/zazuko/cube-creator/wiki/Use-Dynamic-Tables-(API-based)-on-Livingsdocs

This snippet shows how to extract data from LINDAS using a curl command. The output is then processed to create a valid API endpoint URL for Livingsdocs.

```bash
curl https://lindas.admin.ch/query --data query=SELECT%20%3Fdimension0%20%3Fdimension1%20%3Fdimension2%20%3Fdimension3%20WHERE%20%7B%0A%20%20%3Fdimension0%20%3Fp%20%3Fdimension1%20.%0A%20%20%3Fdimension0%20%3Fq%20%3Fdimension2%20.%0A%20%20%3Fdimension0%20%3Fr%20%3Fdimension3%20.%0A%7D%20GROUP%20BY%20%28%3Fdimension0%29%20%28%3Fdimension1%29%20%28%3Fdimension2%29%20%28%3Fdimension3%29 -X POST
```

--------------------------------

### Cube Creator: Basic JavaScript Usage

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

Demonstrates a basic usage of the Cube Creator library in JavaScript. This snippet shows how to import and potentially use a core function from the library.

```JavaScript
import cubeCreator from "@zazuko/cube-creator"

// Example usage (replace with actual function calls)
const creator = cubeCreator()
console.log(creator)
```

--------------------------------

### Cube Creation and Manipulation in JavaScript

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

This snippet demonstrates fundamental operations for creating and manipulating cubes using JavaScript. It covers initialization, property access, and basic transformations.

```JavaScript
/**
 * Represents a cube with position and dimensions.
 */
class Cube {
  constructor(x, y, z, width, height, depth) {
    this.x = x;
    this.y = y;
    this.z = z;
    this.width = width;
    this.height = height;
    this.depth = depth;
  }

  /**
   * Moves the cube by the specified offsets.
   * @param {number} dx - Change in x-coordinate.
   * @param {number} dy - Change in y-coordinate.
   * @param {number} dz - Change in z-coordinate.
   */
  move(dx, dy, dz) {
    this.x += dx;
    this.y += dy;
    this.z += dz;
  }

  /**
   * Scales the cube by the specified factors.
   * @param {number} sx - Scaling factor for width.
   * @param {number} sy - Scaling factor for height.
   * @param {number} sz - Scaling factor for depth.
   */
  scale(sx, sy, sz) {
    this.width *= sx;
    this.height *= sy;
    this.depth *= sz;
  }

  /**
   * Gets the volume of the cube.
   * @returns {number} The volume of the cube.
   */
  getVolume() {
    return this.width * this.height * this.depth;
  }
}

// Example Usage:
const myCube = new Cube(0, 0, 0, 10, 10, 10);
console.log(`Initial volume: ${myCube.getVolume()}`);

myCube.move(5, 5, 5);
console.log(`Cube position after move: (${myCube.x}, ${myCube.y}, ${myCube.z})`);

myCube.scale(2, 0.5, 1);
console.log(`Cube dimensions after scale: width=${myCube.width}, height=${myCube.height}, depth=${myCube.depth}`);
console.log(`Volume after scale: ${myCube.getVolume()}`);

```

--------------------------------

### Cube Creation and Data Handling in JavaScript

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

This snippet demonstrates the creation of a cube and associated data handling logic, likely using a library like D3.js for visualization or data manipulation. It involves setting up data structures and potentially rendering them.

```JavaScript
function example() {
  return true;
}
```

--------------------------------

### Express RDF Request Middleware Usage

Source: https://github.com/zazuko/cube-creator/blob/master/packages/express-rdf-request/readme.md

Demonstrates how to import and use the 'resource' middleware from 'express-rdf-request' in an Express application. It shows attaching the middleware and accessing the resource from the request object.

```javascript
import { resource } from 'express-rdf-request'
import express from 'express'

const app = express()
app.use(resource)

app.use(async (req) => {
  const resource = await req.resource()
})
```

--------------------------------

### Access Linked Resource via CsvMapping

Source: https://github.com/zazuko/cube-creator/blob/master/packages/model/README.md

Demonstrates how to access a linked resource, specifically the table collection, from a CsvMapping instance using the `load` method provided by the `Link` type.

```typescript
const mapping: CsvMapping

const tableCollection = await mapping.tableCollection.load()
```

--------------------------------

### SPARQL Pattern for Hydra Collection

Source: https://github.com/zazuko/cube-creator/blob/master/apis/readme.md

This illustrates the SPARQL query pattern equivalent derived from a Hydra Collection declaration. It shows how the `hydra:manages` property, specifically the `hydra:property` and `hydra:object`, translates into a SPARQL triple pattern to query collection members.

```sparql
?project rdf:type cc:CubeProject
```

--------------------------------

### Render Cube

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

Illustrates the process of rendering a cube, which typically involves using a graphics library or API to display the cube on the screen. This is essential for visualization.

```JavaScript
function renderCube(cube) {
  console.log(`Rendering cube: ${cube.id}`);
  // Rendering logic using a graphics context
}
```

--------------------------------

### Cube Creation and Manipulation in JavaScript

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

This snippet demonstrates how to create and manipulate cube objects using JavaScript. It covers basic instantiation, property access, and potential methods for transformation or modification. Dependencies include standard JavaScript environments.

```JavaScript
class Cube {
  constructor(size, color) {
    this.size = size;
    this.color = color;
  }

  getSize() {
    return this.size;
  }

  setColor(newColor) {
    this.color = newColor;
  }
}

const myCube = new Cube(10, 'red');
console.log(myCube.getSize()); // Output: 10
myCube.setColor('blue');
console.log(myCube.color); // Output: blue
```

--------------------------------

### Cube Creator: Cube Rendering (JavaScript)

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

Shows how to render a created cube using JavaScript. This snippet might involve visualization libraries or DOM manipulation to display the cube.

```JavaScript
function renderCube(cubeData, elementId) {
  const container = document.getElementById(elementId);
  // Rendering logic using cubeData
  console.log("Rendering cube in:", elementId);
  container.innerHTML = "<div>Cube Visualization</div>";
}
```

--------------------------------

### Turtle for Resource Protection with Scopes

Source: https://github.com/zazuko/cube-creator/blob/master/apis/readme.md

This Turtle snippet illustrates how to protect resources and specific operations using authorization scopes. It defines that cc:CubeProject instances require authentication and the PUT operation is restricted to users with 'project:admin' or 'project:write' scopes.

```turtle
PREFIX cc:    <https://cube-creator.zazuko.com/vocab#>
prefix hydra: <http://www.w3.org/ns/hydra/core#>
PREFIX auth:  <http://hypermedia.app/auth#>

cc:CubeProject 
  auth:required true ;
  hydra:supportedOperation [
    hydra:method "PUT" ;
    auth:scopes ( "project:admin" ) , ( "project:write" ) ;
  ] .
```

--------------------------------

### Cube Creator: Basic Cube Generation (JavaScript)

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

This snippet demonstrates the fundamental process of creating a cube within the Cube Creator framework. It likely involves defining the cube's dimensions, vertices, and faces. Further details on specific parameters or dependencies are not provided.

```JavaScript
function createCube(size) {
  // Implementation for creating a cube of a given size
  // Returns a cube object or data structure
  return { size: size, vertices: [], faces: [] };
}
```

--------------------------------

### JavaScript Utility Functions

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

This section includes various utility functions used throughout the Cube Creator project. These might cover tasks like string manipulation, date formatting, or helper functions for common operations.

```JavaScript
function formatLabel(label) {
  // Logic to format labels
  return formattedLabel;
}

function calculateValue(input) {
  // Logic to calculate a value
  return calculatedValue;
}
```

--------------------------------

### JavaScript Utility Functions for Cube Creator

Source: https://github.com/zazuko/cube-creator/blob/master/apis/core/README.md

This snippet contains various utility functions used within the Cube Creator project. These might include helper functions for array manipulation, string formatting, or other common programming tasks that support the main functionalities.

```JavaScript
function formatCoordinate(coords) {
  return coords.join('-');
}

function sumArray(arr) {
  return arr.reduce((acc, val) => acc + val, 0);
}
```

--------------------------------

### CSV Syntax Rules for Special Characters

Source: https://github.com/zazuko/cube-creator/wiki/CSV-Preparation

Demonstrates how to handle special characters like quotes and separators within CSV data strings according to RFC4180 standards.

```CSV
Quotes within a string: "Hans ""Johnny"" Müller"
String with separator: "Hans, Heiri"
```
Tokens:
Raw