@uns-kit/cli 2.0.25 → 2.0.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +175 -175
  3. package/package.json +6 -6
  4. package/templates/api/src/examples/api-example.ts +91 -91
  5. package/templates/azure-pipelines.yml +21 -21
  6. package/templates/codegen/codegen.ts +15 -15
  7. package/templates/codegen/src/uns/uns-tags.ts +1 -1
  8. package/templates/codegen/src/uns/uns-topics.ts +1 -1
  9. package/templates/config-files/config-docker.json +26 -26
  10. package/templates/config-files/config-localhost.json +26 -26
  11. package/templates/cron/AGENTS.md +24 -24
  12. package/templates/cron/src/examples/cron-example.ts +71 -71
  13. package/templates/default/.prettierignore +1 -1
  14. package/templates/default/.prettierrc +7 -7
  15. package/templates/default/AGENTS.md +24 -24
  16. package/templates/default/README.md +43 -43
  17. package/templates/default/config.json +27 -27
  18. package/templates/default/eslint.config.js +30 -30
  19. package/templates/default/gitignore +51 -51
  20. package/templates/default/package.json +49 -49
  21. package/templates/default/src/config/project.config.extension.example +23 -23
  22. package/templates/default/src/config/project.config.extension.ts +6 -6
  23. package/templates/default/src/examples/data-example.ts +86 -86
  24. package/templates/default/src/examples/load-test-data.ts +110 -110
  25. package/templates/default/src/examples/table-example.ts +97 -97
  26. package/templates/default/src/examples/table-window-load-test.ts +446 -446
  27. package/templates/default/src/examples/uns-gateway-cli.ts +10 -10
  28. package/templates/default/src/index.ts +15 -15
  29. package/templates/default/src/uns/uns-assets.ts +12 -12
  30. package/templates/default/src/uns/uns-dictionary.generated.ts +758 -758
  31. package/templates/default/src/uns/uns-measurements.generated.ts +366 -366
  32. package/templates/default/src/uns/uns-tags.ts +2 -2
  33. package/templates/default/src/uns/uns-topics.ts +2 -2
  34. package/templates/default/tsconfig.json +29 -29
  35. package/templates/python/app/README.md +8 -8
  36. package/templates/python/examples/README.md +134 -134
  37. package/templates/python/examples/api_handler.py +28 -28
  38. package/templates/python/examples/data_publish.py +11 -11
  39. package/templates/python/examples/data_subscribe.py +8 -8
  40. package/templates/python/examples/data_transformer.py +17 -17
  41. package/templates/python/examples/table_transformer.py +15 -15
  42. package/templates/python/gateway/cli.py +75 -75
  43. package/templates/python/gateway/client.py +155 -155
  44. package/templates/python/gateway/manager.py +97 -97
  45. package/templates/python/gen/__init__.py +1 -0
  46. package/templates/python/gen/uns_gateway_pb2.py +70 -0
  47. package/templates/python/gen/uns_gateway_pb2_grpc.py +312 -0
  48. package/templates/python/gitignore +47 -47
  49. package/templates/python/proto/uns-gateway.proto +102 -102
  50. package/templates/python/pyproject.toml +4 -4
  51. package/templates/python/runtime.json +4 -4
  52. package/templates/python/scripts/setup.sh +87 -87
  53. package/templates/temporal/src/examples/temporal-example.ts +37 -37
  54. package/templates/uns-dictionary/uns-dictionary.json +650 -650
  55. package/templates/uns-measurements/uns-measurements.json +360 -360
  56. package/templates/vscode/.vscode/launch.json +164 -164
  57. package/templates/vscode/.vscode/settings.json +9 -9
  58. package/templates/vscode/.vscode/tasks.json +27 -27
  59. package/templates/vscode/uns-kit.code-workspace +13 -13
@@ -1,15 +1,15 @@
1
- import type { CodegenConfig } from '@graphql-codegen/cli';
2
- import { ConfigFile } from '@uns-kit/core';
3
-
4
- const appConfig = await ConfigFile.loadConfig();
5
-
6
- const config: CodegenConfig = {
7
- schema: appConfig.uns.graphql,
8
- generates: {
9
- 'src/graphql/schema.ts': {
10
- plugins: ['typescript', 'typescript-operations', 'typescript-resolvers'],
11
- },
12
- },
13
- };
14
-
15
- export default config;
1
+ import type { CodegenConfig } from '@graphql-codegen/cli';
2
+ import { ConfigFile } from '@uns-kit/core';
3
+
4
+ const appConfig = await ConfigFile.loadConfig();
5
+
6
+ const config: CodegenConfig = {
7
+ schema: appConfig.uns.graphql,
8
+ generates: {
9
+ 'src/graphql/schema.ts': {
10
+ plugins: ['typescript', 'typescript-operations', 'typescript-resolvers'],
11
+ },
12
+ },
13
+ };
14
+
15
+ export default config;
@@ -1 +1 @@
1
- export type UnsTags = string & {};
1
+ export type UnsTags = string & {};
@@ -1 +1 @@
1
- export type UnsTopics = string & {};
1
+ export type UnsTopics = string & {};
@@ -1,27 +1,27 @@
1
- {
2
- "uns": {
3
- "graphql": "http://uns-datahub-controller:3200/graphql",
4
- "rest": "http://uns-datahub-controller:3200/api",
5
- "processName": "__APP_NAME__",
6
- "instanceMode": "wait",
7
- "handover": true,
8
- "jwksWellKnownUrl": "http://uns-datahub-controller:3200/api/.well-known/jwks.json",
9
- "kidWellKnownUrl": "http://uns-datahub-controller:3200/api/.well-known/kid",
10
- "email": "user@example-org.com",
11
- "password": "secret"
12
- },
13
- "infra": {
14
- "host": "mosquitto:1883"
15
- },
16
- "output": {
17
- "host": "mosquitto:1883"
18
- },
19
- "input": {
20
- "host": "mosquitto:1883"
21
- },
22
- "devops": {
23
- "provider": "azure-devops",
24
- "organization": "example-org",
25
- "project": "example-project"
26
- }
1
+ {
2
+ "uns": {
3
+ "graphql": "http://uns-datahub-controller:3200/graphql",
4
+ "rest": "http://uns-datahub-controller:3200/api",
5
+ "processName": "__APP_NAME__",
6
+ "instanceMode": "wait",
7
+ "handover": true,
8
+ "jwksWellKnownUrl": "http://uns-datahub-controller:3200/api/.well-known/jwks.json",
9
+ "kidWellKnownUrl": "http://uns-datahub-controller:3200/api/.well-known/kid",
10
+ "email": "user@example-org.com",
11
+ "password": "secret"
12
+ },
13
+ "infra": {
14
+ "host": "mosquitto:1883"
15
+ },
16
+ "output": {
17
+ "host": "mosquitto:1883"
18
+ },
19
+ "input": {
20
+ "host": "mosquitto:1883"
21
+ },
22
+ "devops": {
23
+ "provider": "azure-devops",
24
+ "organization": "example-org",
25
+ "project": "example-project"
26
+ }
27
27
  }
@@ -1,27 +1,27 @@
1
- {
2
- "uns": {
3
- "graphql": "http://localhost:3200/graphql",
4
- "rest": "http://localhost:3200/api",
5
- "processName": "__APP_NAME__",
6
- "instanceMode": "wait",
7
- "handover": true,
8
- "jwksWellKnownUrl": "http://localhost:3200/api/.well-known/jwks.json",
9
- "kidWellKnownUrl": "http://localhost:3200/api/.well-known/kid",
10
- "email": "user@example-org.com",
11
- "password": "secret"
12
- },
13
- "infra": {
14
- "host": "localhost:1883"
15
- },
16
- "output": {
17
- "host": "localhost:1883"
18
- },
19
- "input": {
20
- "host": "localhost:1883"
21
- },
22
- "devops": {
23
- "provider": "azure-devops",
24
- "organization": "example-org",
25
- "project": "example-project"
26
- }
1
+ {
2
+ "uns": {
3
+ "graphql": "http://localhost:3200/graphql",
4
+ "rest": "http://localhost:3200/api",
5
+ "processName": "__APP_NAME__",
6
+ "instanceMode": "wait",
7
+ "handover": true,
8
+ "jwksWellKnownUrl": "http://localhost:3200/api/.well-known/jwks.json",
9
+ "kidWellKnownUrl": "http://localhost:3200/api/.well-known/kid",
10
+ "email": "user@example-org.com",
11
+ "password": "secret"
12
+ },
13
+ "infra": {
14
+ "host": "localhost:1883"
15
+ },
16
+ "output": {
17
+ "host": "localhost:1883"
18
+ },
19
+ "input": {
20
+ "host": "localhost:1883"
21
+ },
22
+ "devops": {
23
+ "provider": "azure-devops",
24
+ "organization": "example-org",
25
+ "project": "example-project"
26
+ }
27
27
  }
@@ -1,24 +1,24 @@
1
- # Agent Onboarding (template)
2
-
3
- Pointers for AI/code-assist tools when working in this generated project.
4
-
5
- ## What to read locally
6
-
7
- - `package.json` for scripts (`generate-uns-*`, `generate-codegen`, etc.).
8
- - `config.schema.json` for the app config shape; `processName` is required.
9
- - `src/examples/*.ts` for cron-driven publish patterns and description registration.
10
- - Installed docs (under `node_modules`):
11
- - `@uns-kit/core/README.md`
12
- - `@uns-kit/api/README.md` (if installed)
13
- - `@uns-kit/cron/README.md` (if installed)
14
- - `@uns-kit/temporal/README.md` (if installed)
15
- - `@uns-kit/cli/README.md` (if installed)
16
-
17
- ## Generators in this project
18
-
19
- - `pnpm run generate-uns-dictionary` -> updates `src/uns/uns-dictionary.generated.ts`
20
- - `pnpm run generate-uns-measurements` -> updates `src/uns/uns-measurements.generated.ts`
21
- - `pnpm run generate-uns-reference` -> runs both
22
- - `pnpm run generate-uns-metadata` -> refreshes topic/tag unions (requires GraphQL connectivity)
23
- - `pnpm run generate-codegen` -> GraphQL codegen (after configure-codegen)
24
- - `pnpm run sync-uns-schema -- --controller-url ... --token ...` -> pulls `uns-dictionary.json` + `uns-measurements.json` from the controller and regenerates local TS helpers
1
+ # Agent Onboarding (template)
2
+
3
+ Pointers for AI/code-assist tools when working in this generated project.
4
+
5
+ ## What to read locally
6
+
7
+ - `package.json` for scripts (`generate-uns-*`, `generate-codegen`, etc.).
8
+ - `config.schema.json` for the app config shape; `processName` is required.
9
+ - `src/examples/*.ts` for cron-driven publish patterns and description registration.
10
+ - Installed docs (under `node_modules`):
11
+ - `@uns-kit/core/README.md`
12
+ - `@uns-kit/api/README.md` (if installed)
13
+ - `@uns-kit/cron/README.md` (if installed)
14
+ - `@uns-kit/temporal/README.md` (if installed)
15
+ - `@uns-kit/cli/README.md` (if installed)
16
+
17
+ ## Generators in this project
18
+
19
+ - `pnpm run generate-uns-dictionary` -> updates `src/uns/uns-dictionary.generated.ts`
20
+ - `pnpm run generate-uns-measurements` -> updates `src/uns/uns-measurements.generated.ts`
21
+ - `pnpm run generate-uns-reference` -> runs both
22
+ - `pnpm run generate-uns-metadata` -> refreshes topic/tag unions (requires GraphQL connectivity)
23
+ - `pnpm run generate-codegen` -> GraphQL codegen (after configure-codegen)
24
+ - `pnpm run sync-uns-schema -- --controller-url ... --token ...` -> pulls `uns-dictionary.json` + `uns-measurements.json` from the controller and regenerates local TS helpers
@@ -1,71 +1,71 @@
1
- /**
2
- * Change this file according to your specifications and rename it to index.ts
3
- */
4
- import { UnsProxyProcess, ConfigFile, UnsEvents, getLogger } from "@uns-kit/core";
5
- import { registerAttributeDescriptions, registerObjectTypeDescriptions } from "@uns-kit/core/uns/uns-dictionary-registry.js";
6
- import "@uns-kit/cron";
7
- import { type UnsProxyProcessWithCron } from "@uns-kit/cron";
8
- import { UnsTopics } from "@uns-kit/core/uns/uns-topics.js";
9
- import { UnsPacket } from "@uns-kit/core/uns/uns-packet.js";
10
- import {
11
- GeneratedObjectTypes,
12
- GeneratedAttributes,
13
- GeneratedAttributesByType,
14
- GeneratedAttributeDescriptions,
15
- GeneratedObjectTypeDescriptions,
16
- } from "../uns/uns-dictionary.generated.js";
17
- import { GeneratedPhysicalMeasurements } from "../uns/uns-measurements.generated.js";
18
- import { GeneratedAssets, resolveGeneratedAsset } from "../uns/uns-assets.js";
19
-
20
- const logger = getLogger(import.meta.url);
21
-
22
-
23
- /**
24
- * Load the configuration from a file.
25
- * On the server, this file is provided by the `uns-datahub-controller`.
26
- * In the development environment, you are responsible for creating and maintaining this file and its contents.
27
- */
28
- const config = await ConfigFile.loadConfig();
29
- registerObjectTypeDescriptions(GeneratedObjectTypeDescriptions);
30
- registerAttributeDescriptions(GeneratedAttributeDescriptions);
31
-
32
- /**
33
- * Connect to the output broker and create a crontab proxy
34
- */
35
- const unsProxyProcess = new UnsProxyProcess(config.infra.host!, {processName:config.uns.processName}) as UnsProxyProcessWithCron;;
36
- const mqttOutput = await unsProxyProcess.createUnsMqttProxy((config.output?.host)!, "templateUnsRttOutput", config.uns.instanceMode!, config.uns.handover!, { publishThrottlingDelay: 1000});
37
- const cronInput = await unsProxyProcess.createCrontabProxy("* * * * * *");
38
-
39
- /**
40
- * Event listener for cron events.
41
- * On each cron event, publish a message to the MQTT output broker.
42
- */
43
- cronInput.event.on("cronEvent", async (event: UnsEvents["cronEvent"]) => {
44
- try {
45
- const time = UnsPacket.formatToISO8601(new Date());
46
- const numberValue: number = 42;
47
- const topic: UnsTopics = "example/";
48
- const asset = resolveGeneratedAsset("asset");
49
- const assetDescription = "Sample asset";
50
-
51
- const dataGroup = "sensor";
52
-
53
- mqttOutput.publishMqttMessage({
54
- topic,
55
- asset,
56
- assetDescription,
57
- objectType: GeneratedObjectTypes.equipment,
58
- objectId: "main",
59
- attributes: [
60
- {
61
- attribute: GeneratedAttributesByType["energy-resource"]["current"],
62
- data: { dataGroup, time, value: numberValue, uom: GeneratedPhysicalMeasurements.Ampere }
63
- }
64
- ],
65
- });
66
- } catch (error) {
67
- const reason = error instanceof Error ? error : new Error(String(error));
68
- logger.error(`Error publishing message to MQTT: ${reason.message}`);
69
- throw error;
70
- }
71
- });
1
+ /**
2
+ * Change this file according to your specifications and rename it to index.ts
3
+ */
4
+ import { UnsProxyProcess, ConfigFile, UnsEvents, getLogger } from "@uns-kit/core";
5
+ import { registerAttributeDescriptions, registerObjectTypeDescriptions } from "@uns-kit/core/uns/uns-dictionary-registry.js";
6
+ import "@uns-kit/cron";
7
+ import { type UnsProxyProcessWithCron } from "@uns-kit/cron";
8
+ import { UnsTopics } from "@uns-kit/core/uns/uns-topics.js";
9
+ import { UnsPacket } from "@uns-kit/core/uns/uns-packet.js";
10
+ import {
11
+ GeneratedObjectTypes,
12
+ GeneratedAttributes,
13
+ GeneratedAttributesByType,
14
+ GeneratedAttributeDescriptions,
15
+ GeneratedObjectTypeDescriptions,
16
+ } from "../uns/uns-dictionary.generated.js";
17
+ import { GeneratedPhysicalMeasurements } from "../uns/uns-measurements.generated.js";
18
+ import { GeneratedAssets, resolveGeneratedAsset } from "../uns/uns-assets.js";
19
+
20
+ const logger = getLogger(import.meta.url);
21
+
22
+
23
+ /**
24
+ * Load the configuration from a file.
25
+ * On the server, this file is provided by the `uns-datahub-controller`.
26
+ * In the development environment, you are responsible for creating and maintaining this file and its contents.
27
+ */
28
+ const config = await ConfigFile.loadConfig();
29
+ registerObjectTypeDescriptions(GeneratedObjectTypeDescriptions);
30
+ registerAttributeDescriptions(GeneratedAttributeDescriptions);
31
+
32
+ /**
33
+ * Connect to the output broker and create a crontab proxy
34
+ */
35
+ const unsProxyProcess = new UnsProxyProcess(config.infra.host!, {processName:config.uns.processName}) as UnsProxyProcessWithCron;;
36
+ const mqttOutput = await unsProxyProcess.createUnsMqttProxy((config.output?.host)!, "templateUnsRttOutput", config.uns.instanceMode!, config.uns.handover!, { publishThrottlingDelay: 1000});
37
+ const cronInput = await unsProxyProcess.createCrontabProxy("* * * * * *");
38
+
39
+ /**
40
+ * Event listener for cron events.
41
+ * On each cron event, publish a message to the MQTT output broker.
42
+ */
43
+ cronInput.event.on("cronEvent", async (event: UnsEvents["cronEvent"]) => {
44
+ try {
45
+ const time = UnsPacket.formatToISO8601(new Date());
46
+ const numberValue: number = 42;
47
+ const topic: UnsTopics = "example/";
48
+ const asset = resolveGeneratedAsset("asset");
49
+ const assetDescription = "Sample asset";
50
+
51
+ const dataGroup = "sensor";
52
+
53
+ mqttOutput.publishMqttMessage({
54
+ topic,
55
+ asset,
56
+ assetDescription,
57
+ objectType: GeneratedObjectTypes.equipment,
58
+ objectId: "main",
59
+ attributes: [
60
+ {
61
+ attribute: GeneratedAttributesByType["energy-resource"]["current"],
62
+ data: { dataGroup, time, value: numberValue, uom: GeneratedPhysicalMeasurements.Ampere }
63
+ }
64
+ ],
65
+ });
66
+ } catch (error) {
67
+ const reason = error instanceof Error ? error : new Error(String(error));
68
+ logger.error(`Error publishing message to MQTT: ${reason.message}`);
69
+ throw error;
70
+ }
71
+ });
@@ -1,2 +1,2 @@
1
- dist
1
+ dist
2
2
  node_modules
@@ -1,7 +1,7 @@
1
- {
2
- "semi": true,
3
- "singleQuote": true,
4
- "tabWidth": 2,
5
- "trailingComma": "all",
6
- "printWidth": 140
7
- }
1
+ {
2
+ "semi": true,
3
+ "singleQuote": true,
4
+ "tabWidth": 2,
5
+ "trailingComma": "all",
6
+ "printWidth": 140
7
+ }
@@ -1,24 +1,24 @@
1
- # Agent Onboarding (template)
2
-
3
- Pointers for AI/code-assist tools when working in this generated project.
4
-
5
- ## What to read locally
6
-
7
- - `package.json` for scripts (`generate-uns-*`, `generate-codegen`, etc.).
8
- - `config.schema.json` for the app config shape; `processName` is required.
9
- - `src/examples/*.ts` for idiomatic publishing (multi-attribute) and description registration.
10
- - Installed docs (under `node_modules`):
11
- - `@uns-kit/core/README.md`
12
- - `@uns-kit/api/README.md` (if installed)
13
- - `@uns-kit/cron/README.md` (if installed)
14
- - `@uns-kit/temporal/README.md` (if installed)
15
- - `@uns-kit/cli/README.md` (if installed)
16
-
17
- ## Generators in this project
18
-
19
- - `pnpm run generate-uns-dictionary` -> updates `src/uns/uns-dictionary.generated.ts`
20
- - `pnpm run generate-uns-measurements` -> updates `src/uns/uns-measurements.generated.ts`
21
- - `pnpm run generate-uns-reference` -> runs both
22
- - `pnpm run generate-uns-metadata` -> refreshes topic/tag unions (requires GraphQL connectivity)
23
- - `pnpm run generate-codegen` -> GraphQL codegen (after configure-codegen)
24
- - `pnpm run sync-uns-schema -- --controller-url ... --token ...` -> pulls `uns-dictionary.json` + `uns-measurements.json` from the controller and regenerates local TS helpers
1
+ # Agent Onboarding (template)
2
+
3
+ Pointers for AI/code-assist tools when working in this generated project.
4
+
5
+ ## What to read locally
6
+
7
+ - `package.json` for scripts (`generate-uns-*`, `generate-codegen`, etc.).
8
+ - `config.schema.json` for the app config shape; `processName` is required.
9
+ - `src/examples/*.ts` for idiomatic publishing (multi-attribute) and description registration.
10
+ - Installed docs (under `node_modules`):
11
+ - `@uns-kit/core/README.md`
12
+ - `@uns-kit/api/README.md` (if installed)
13
+ - `@uns-kit/cron/README.md` (if installed)
14
+ - `@uns-kit/temporal/README.md` (if installed)
15
+ - `@uns-kit/cli/README.md` (if installed)
16
+
17
+ ## Generators in this project
18
+
19
+ - `pnpm run generate-uns-dictionary` -> updates `src/uns/uns-dictionary.generated.ts`
20
+ - `pnpm run generate-uns-measurements` -> updates `src/uns/uns-measurements.generated.ts`
21
+ - `pnpm run generate-uns-reference` -> runs both
22
+ - `pnpm run generate-uns-metadata` -> refreshes topic/tag unions (requires GraphQL connectivity)
23
+ - `pnpm run generate-codegen` -> GraphQL codegen (after configure-codegen)
24
+ - `pnpm run sync-uns-schema -- --controller-url ... --token ...` -> pulls `uns-dictionary.json` + `uns-measurements.json` from the controller and regenerates local TS helpers
@@ -1,43 +1,43 @@
1
- # __APP_NAME__
2
-
3
- Generated with `@uns-kit/cli`.
4
-
5
- Requires Node.js 22+ and pnpm (see `packageManager` in package.json).
6
-
7
- ## Scripts
8
-
9
- ```bash
10
- pnpm run dev # start the local development loop
11
- pnpm run build # emit dist/ output
12
- pnpm run start # run the compiled entrypoint
13
- pnpm run generate-config-schema # regenerate config.schema.json and AppConfig augmentations
14
- pnpm run generate-codegen # regenerate typed GraphQL operations (after configure-codegen)
15
- pnpm run generate-uns-metadata # rebuild UNS topics/tags from the live schema
16
- pnpm run generate-uns-dictionary # generate typed object/attribute dictionary from uns-dictionary.json
17
- pnpm run generate-uns-measurements # generate typed measurement units from uns-measurements.json
18
- pnpm run generate-uns-reference # run both dictionary + measurements generators
19
- pnpm run sync-uns-schema -- --controller-url http://localhost:3200 --token <admin-bearer-token> # pull dictionary + measurements from the controller
20
- ```
21
-
22
- ## Configuration
23
-
24
- Update `config.json` with your broker, UNS URLs, and credentials. The generated file contains sensible defaults for local development.
25
-
26
- ## Next Steps
27
-
28
- - Install additional plugins: `pnpm add @uns-kit/api` etc.
29
- - Create MQTT proxies or Temporal workflows inside `src/index.ts`.
30
- - Extend `src/config/project.config.extension.ts` with project-specific sections and run `pnpm run generate-config-schema` (reload your editor's TS server afterward if completions lag).
31
- - Run `uns-kit configure-devops` to add the Azure DevOps pull-request tooling.
32
- - Run `uns-kit configure-vscode` to copy workspace/launch configuration for VS Code.
33
- - Run `uns-kit configure-codegen` to scaffold GraphQL code generation and UNS refresh scripts.
34
- - Run `pnpm run sync-uns-schema -- --controller-url ... --token ...` to pull `uns-dictionary.json` and `uns-measurements.json` from the controller export into this project, then regenerate the typed files automatically.
35
- - If you want to curate local files manually, edit `uns-dictionary.json` (object types/attributes + descriptions) and run `pnpm run generate-uns-dictionary` to emit `src/uns/uns-dictionary.generated.ts` for IDE hints/metadata; publish calls will automatically fall back to these descriptions when you omit them.
36
- - Edit `uns-measurements.json` (units + descriptions) and run `pnpm run generate-uns-measurements` to emit `src/uns/uns-measurements.generated.ts` and feed measurement unit IntelliSense.
37
- - Run `uns-kit configure-api` / `configure-cron` / `configure-temporal` to pull in example stubs and install the matching UNS plugins (add `--overwrite` to refresh templates).
38
- - Run `uns-kit configure-python` to copy the Python gateway client template (examples, scripts, proto).
39
- - Commit your new project and start building!
40
-
41
- ## Agent Onboarding (for AI/code-assist tools)
42
-
43
- For agent guidance, see the local [`AGENTS.md`](./AGENTS.md).
1
+ # __APP_NAME__
2
+
3
+ Generated with `@uns-kit/cli`.
4
+
5
+ Requires Node.js 22+ and pnpm (see `packageManager` in package.json).
6
+
7
+ ## Scripts
8
+
9
+ ```bash
10
+ pnpm run dev # start the local development loop
11
+ pnpm run build # emit dist/ output
12
+ pnpm run start # run the compiled entrypoint
13
+ pnpm run generate-config-schema # regenerate config.schema.json and AppConfig augmentations
14
+ pnpm run generate-codegen # regenerate typed GraphQL operations (after configure-codegen)
15
+ pnpm run generate-uns-metadata # rebuild UNS topics/tags from the live schema
16
+ pnpm run generate-uns-dictionary # generate typed object/attribute dictionary from uns-dictionary.json
17
+ pnpm run generate-uns-measurements # generate typed measurement units from uns-measurements.json
18
+ pnpm run generate-uns-reference # run both dictionary + measurements generators
19
+ pnpm run sync-uns-schema -- --controller-url http://localhost:3200 --token <admin-bearer-token> # pull dictionary + measurements from the controller
20
+ ```
21
+
22
+ ## Configuration
23
+
24
+ Update `config.json` with your broker, UNS URLs, and credentials. The generated file contains sensible defaults for local development.
25
+
26
+ ## Next Steps
27
+
28
+ - Install additional plugins: `pnpm add @uns-kit/api` etc.
29
+ - Create MQTT proxies or Temporal workflows inside `src/index.ts`.
30
+ - Extend `src/config/project.config.extension.ts` with project-specific sections and run `pnpm run generate-config-schema` (reload your editor's TS server afterward if completions lag).
31
+ - Run `uns-kit configure-devops` to add the Azure DevOps pull-request tooling.
32
+ - Run `uns-kit configure-vscode` to copy workspace/launch configuration for VS Code.
33
+ - Run `uns-kit configure-codegen` to scaffold GraphQL code generation and UNS refresh scripts.
34
+ - Run `pnpm run sync-uns-schema -- --controller-url ... --token ...` to pull `uns-dictionary.json` and `uns-measurements.json` from the controller export into this project, then regenerate the typed files automatically.
35
+ - If you want to curate local files manually, edit `uns-dictionary.json` (object types/attributes + descriptions) and run `pnpm run generate-uns-dictionary` to emit `src/uns/uns-dictionary.generated.ts` for IDE hints/metadata; publish calls will automatically fall back to these descriptions when you omit them.
36
+ - Edit `uns-measurements.json` (units + descriptions) and run `pnpm run generate-uns-measurements` to emit `src/uns/uns-measurements.generated.ts` and feed measurement unit IntelliSense.
37
+ - Run `uns-kit configure-api` / `configure-cron` / `configure-temporal` to pull in example stubs and install the matching UNS plugins (add `--overwrite` to refresh templates).
38
+ - Run `uns-kit configure-python` to copy the Python gateway client template (examples, scripts, proto).
39
+ - Commit your new project and start building!
40
+
41
+ ## Agent Onboarding (for AI/code-assist tools)
42
+
43
+ For agent guidance, see the local [`AGENTS.md`](./AGENTS.md).
@@ -1,27 +1,27 @@
1
- {
2
- "uns": {
3
- "graphql": "http://localhost:3200/graphql",
4
- "rest": "http://localhost:3200/api",
5
- "processName": "__APP_NAME__",
6
- "instanceMode": "wait",
7
- "handover": true,
8
- "jwksWellKnownUrl": "http://localhost:3200/api/.well-known/jwks.json",
9
- "kidWellKnownUrl": "http://localhost:3200/api/.well-known/kid",
10
- "email": "user@example.com",
11
- "password": "123"
12
- },
13
- "infra": {
14
- "host": "localhost"
15
- },
16
- "output": {
17
- "host": "localhost"
18
- },
19
- "input": {
20
- "host": "localhost"
21
- },
22
- "devops": {
23
- "provider": "azure-devops",
24
- "organization": "example-org",
25
- "project": "example-project"
26
- }
27
- }
1
+ {
2
+ "uns": {
3
+ "graphql": "http://localhost:3200/graphql",
4
+ "rest": "http://localhost:3200/api",
5
+ "processName": "__APP_NAME__",
6
+ "instanceMode": "wait",
7
+ "handover": true,
8
+ "jwksWellKnownUrl": "http://localhost:3200/api/.well-known/jwks.json",
9
+ "kidWellKnownUrl": "http://localhost:3200/api/.well-known/kid",
10
+ "email": "user@example.com",
11
+ "password": "123"
12
+ },
13
+ "infra": {
14
+ "host": "localhost"
15
+ },
16
+ "output": {
17
+ "host": "localhost"
18
+ },
19
+ "input": {
20
+ "host": "localhost"
21
+ },
22
+ "devops": {
23
+ "provider": "azure-devops",
24
+ "organization": "example-org",
25
+ "project": "example-project"
26
+ }
27
+ }
@@ -1,30 +1,30 @@
1
- // eslint.config.js
2
-
3
- import { defineConfig } from 'eslint/config';
4
-
5
- export default defineConfig([
6
- // Apply to all source and test files
7
- {
8
- files: ['src/**/*', 'test/**/*'],
9
- ignores: ['dist/', 'node_modules/'], // Folders to ignore
10
- languageOptions: {
11
- parserOptions: {
12
- ecmaVersion: 'latest', // Use latest ECMAScript version
13
- sourceType: 'module', // Enable ES modules
14
- },
15
- },
16
- rules: {
17
- semi: ['warn', 'always'],
18
- },
19
- },
20
-
21
- // Override specifically for test files
22
- {
23
- files: ['test/**/*'],
24
- rules: {
25
- 'no-console': 'off',
26
- },
27
- },
28
-
29
- // Additional configurations can go here
30
- ]);
1
+ // eslint.config.js
2
+
3
+ import { defineConfig } from 'eslint/config';
4
+
5
+ export default defineConfig([
6
+ // Apply to all source and test files
7
+ {
8
+ files: ['src/**/*', 'test/**/*'],
9
+ ignores: ['dist/', 'node_modules/'], // Folders to ignore
10
+ languageOptions: {
11
+ parserOptions: {
12
+ ecmaVersion: 'latest', // Use latest ECMAScript version
13
+ sourceType: 'module', // Enable ES modules
14
+ },
15
+ },
16
+ rules: {
17
+ semi: ['warn', 'always'],
18
+ },
19
+ },
20
+
21
+ // Override specifically for test files
22
+ {
23
+ files: ['test/**/*'],
24
+ rules: {
25
+ 'no-console': 'off',
26
+ },
27
+ },
28
+
29
+ // Additional configurations can go here
30
+ ]);