@uns-kit/cli 2.0.56 → 2.0.57

package/templates/api/src/examples/api-example.ts

@@ -1,155 +1,155 @@
-/**
- * Change this file according to your specifications and rename it to index.ts
- *
- * This example shows how to register GET and POST API endpoints using @uns-kit/api.
- * Each endpoint is tied to a UNS topic/asset/objectType/objectId/attribute path and
- * is automatically registered with the UNS controller and exposed via Swagger.
- *
- * Endpoint signature:
- *   api.get(topic, asset, objectType, objectId, attribute, options?)
- *   api.post(topic, asset, objectType, objectId, attribute, options?)
- *
- * Events:
- *   apiGetEvent  — fired for every incoming GET request
- *   apiPostEvent — fired for every incoming POST request
- */
-import { UnsProxyProcess, ConfigFile } from "@uns-kit/core";
-import { IApiProxyOptions } from "@uns-kit/core";
-import type { UnsEvents } from "@uns-kit/core";
-import "@uns-kit/api";
-import { type UnsProxyProcessWithApi } from "@uns-kit/api";
-
-/**
- * Load the configuration from a file.
- * On the server, this file is provided by the `uns-datahub-controller`.
- * In the development environment, you are responsible for creating and maintaining this file.
- */
-const config = await ConfigFile.loadConfig();
-
-/**
- * Create the API proxy.
- * Auth is automatically applied to every registered endpoint.
- * Use jwksWellKnownUrl (preferred in production) or jwtSecret (dev/simple deployments).
- */
-const unsProxyProcess = new UnsProxyProcess(config.infra.host!, { processName: config.uns.processName }) as UnsProxyProcessWithApi;
-const apiOptions: IApiProxyOptions = config.uns?.jwksWellKnownUrl
-  ? {
-      jwks: {
-        wellKnownJwksUrl: config.uns.jwksWellKnownUrl,
-        ...(config.uns.kidWellKnownUrl !== undefined
-          ? { activeKidUrl: config.uns.kidWellKnownUrl }
-          : {}),
-      },
-    }
-  : {
-      jwtSecret: "CHANGEME",
-    };
-const apiInput = await unsProxyProcess.createApiProxy("templateUnsApiInput", apiOptions);
-
-// ─── GET endpoints ────────────────────────────────────────────────────────────
-
-/**
- * Register a GET endpoint.
- * Query params are validated automatically; required params return 400 when missing.
- * chatCanonical maps natural-language field names to query params for LLM tooling.
- */
-await apiInput.get(
-  "enterprise/site/area/line/",
-  "line-3-furnace",
-  "energy-resource",
-  "main-bus",
-  "current",
-  {
-    tags: ["Energy"],
-    apiDescription: "Current reading for line-3-furnace main-bus",
-    queryParams: [
-      { name: "from", type: "string", required: false, description: "Start of time range (ISO 8601)", chatCanonical: "from" },
-      { name: "to",   type: "string", required: false, description: "End of time range (ISO 8601)",   chatCanonical: "to"   },
-      { name: "limit", type: "number", required: false, description: "Maximum number of records",     chatCanonical: "limit", defaultValue: 100 },
-    ],
-    chatDefaults: { limit: 100 },
-  }
-);
-
-await apiInput.get(
-  "enterprise/site/area/line/",
-  "line-3-compressor",
-  "utility-resource",
-  "air-loop-1",
-  "pressure",
-  {
-    tags: ["Utility"],
-    apiDescription: "Pressure reading for line-3-compressor air-loop-1",
-    queryParams: [
-      { name: "limit", type: "number", required: false, description: "Maximum number of records", defaultValue: 50 },
-    ],
-  }
-);
-
-// ─── POST endpoints ───────────────────────────────────────────────────────────
-
-/**
- * Register a POST endpoint.
- * Use POST when the caller needs to send a request body (commands, write operations, etc.).
- * The requestBody schema is published to Swagger so clients know what to send.
- */
-await apiInput.post(
-  "enterprise/site/area/line/",
-  "line-3-furnace",
-  "energy-resource",
-  "main-bus",
-  "setpoint",
-  {
-    tags: ["Energy"],
-    apiDescription: "Write a new setpoint for line-3-furnace main-bus",
-    requestBody: {
-      description: "Setpoint payload",
-      required: true,
-      schema: {
-        type: "object",
-        required: ["value"],
-        properties: {
-          value: { type: "number", description: "Target setpoint value" },
-          unit:  { type: "string", description: "Unit of measurement, e.g. A" },
-        },
-      },
-    },
-  }
-);
-
-// ─── Event handlers ───────────────────────────────────────────────────────────
-
-/**
- * Handle all GET requests.
- * event.req is the Express Request; event.res is the Express Response.
- * Use event.req.query for query parameters and event.req.appContext for UNS context.
- */
-apiInput.event.on("apiGetEvent", (event: UnsEvents["apiGetEvent"]) => {
-  try {
-    // const { from, to, limit } = event.req.query;
-    // Add your data-fetching logic here (e.g. SQL query, time-series lookup)
-    event.res.json({ status: "ok", data: [] });
-  } catch (error) {
-    event.res.status(400).json({ error: "Bad request" });
-  }
-});
-
-/**
- * Handle all POST requests.
- * event.req.body contains the parsed JSON body (Express json() middleware is pre-configured).
- */
-apiInput.event.on("apiPostEvent", (event: UnsEvents["apiPostEvent"]) => {
-  try {
-    const body = event.req.body as { value?: number; unit?: string };
-    // Add your write/command logic here
-    event.res.json({ status: "ok", received: body });
-  } catch (error) {
-    event.res.status(400).json({ error: "Bad request" });
-  }
-});
-
-// ─── NOTE: registerCatchAll ───────────────────────────────────────────────────
-//
-// registerCatchAll() is used ONLY by the uns-api-global microservice, which acts
-// as a catch-all gateway for an entire topic namespace. Regular microservices
-// do NOT call this — use get() / post() above for per-attribute endpoints.
+/**
+ * Change this file according to your specifications and rename it to index.ts
+ *
+ * This example shows how to register GET and POST API endpoints using @uns-kit/api.
+ * Each endpoint is tied to a UNS topic/asset/objectType/objectId/attribute path and
+ * is automatically registered with the UNS controller and exposed via Swagger.
+ *
+ * Endpoint signature:
+ *   api.get(topic, asset, objectType, objectId, attribute, options?)
+ *   api.post(topic, asset, objectType, objectId, attribute, options?)
+ *
+ * Events:
+ *   apiGetEvent  — fired for every incoming GET request
+ *   apiPostEvent — fired for every incoming POST request
+ */
+import { UnsProxyProcess, ConfigFile } from "@uns-kit/core";
+import { IApiProxyOptions } from "@uns-kit/core";
+import type { UnsEvents } from "@uns-kit/core";
+import "@uns-kit/api";
+import { type UnsProxyProcessWithApi } from "@uns-kit/api";
+
+/**
+ * Load the configuration from a file.
+ * On the server, this file is provided by the `uns-datahub-controller`.
+ * In the development environment, you are responsible for creating and maintaining this file.
+ */
+const config = await ConfigFile.loadConfig();
+
+/**
+ * Create the API proxy.
+ * Auth is automatically applied to every registered endpoint.
+ * Use jwksWellKnownUrl (preferred in production) or jwtSecret (dev/simple deployments).
+ */
+const unsProxyProcess = new UnsProxyProcess(config.infra.host!, { processName: config.uns.processName }) as UnsProxyProcessWithApi;
+const apiOptions: IApiProxyOptions = config.uns?.jwksWellKnownUrl
+  ? {
+      jwks: {
+        wellKnownJwksUrl: config.uns.jwksWellKnownUrl,
+        ...(config.uns.kidWellKnownUrl !== undefined
+          ? { activeKidUrl: config.uns.kidWellKnownUrl }
+          : {}),
+      },
+    }
+  : {
+      jwtSecret: "CHANGEME",
+    };
+const apiInput = await unsProxyProcess.createApiProxy("templateUnsApiInput", apiOptions);
+
+// ─── GET endpoints ────────────────────────────────────────────────────────────
+
+/**
+ * Register a GET endpoint.
+ * Query params are validated automatically; required params return 400 when missing.
+ * chatCanonical maps natural-language field names to query params for LLM tooling.
+ */
+await apiInput.get(
+  "enterprise/site/area/line/",
+  "line-3-furnace",
+  "energy-resource",
+  "main-bus",
+  "current",
+  {
+    tags: ["Energy"],
+    apiDescription: "Current reading for line-3-furnace main-bus",
+    queryParams: [
+      { name: "from", type: "string", required: false, description: "Start of time range (ISO 8601)", chatCanonical: "from" },
+      { name: "to",   type: "string", required: false, description: "End of time range (ISO 8601)",   chatCanonical: "to"   },
+      { name: "limit", type: "number", required: false, description: "Maximum number of records",     chatCanonical: "limit", defaultValue: 100 },
+    ],
+    chatDefaults: { limit: 100 },
+  }
+);
+
+await apiInput.get(
+  "enterprise/site/area/line/",
+  "line-3-compressor",
+  "utility-resource",
+  "air-loop-1",
+  "pressure",
+  {
+    tags: ["Utility"],
+    apiDescription: "Pressure reading for line-3-compressor air-loop-1",
+    queryParams: [
+      { name: "limit", type: "number", required: false, description: "Maximum number of records", defaultValue: 50 },
+    ],
+  }
+);
+
+// ─── POST endpoints ───────────────────────────────────────────────────────────
+
+/**
+ * Register a POST endpoint.
+ * Use POST when the caller needs to send a request body (commands, write operations, etc.).
+ * The requestBody schema is published to Swagger so clients know what to send.
+ */
+await apiInput.post(
+  "enterprise/site/area/line/",
+  "line-3-furnace",
+  "energy-resource",
+  "main-bus",
+  "setpoint",
+  {
+    tags: ["Energy"],
+    apiDescription: "Write a new setpoint for line-3-furnace main-bus",
+    requestBody: {
+      description: "Setpoint payload",
+      required: true,
+      schema: {
+        type: "object",
+        required: ["value"],
+        properties: {
+          value: { type: "number", description: "Target setpoint value" },
+          unit:  { type: "string", description: "Unit of measurement, e.g. A" },
+        },
+      },
+    },
+  }
+);
+
+// ─── Event handlers ───────────────────────────────────────────────────────────
+
+/**
+ * Handle all GET requests.
+ * event.req is the Express Request; event.res is the Express Response.
+ * Use event.req.query for query parameters and event.req.appContext for UNS context.
+ */
+apiInput.event.on("apiGetEvent", (event: UnsEvents["apiGetEvent"]) => {
+  try {
+    // const { from, to, limit } = event.req.query;
+    // Add your data-fetching logic here (e.g. SQL query, time-series lookup)
+    event.res.json({ status: "ok", data: [] });
+  } catch (error) {
+    event.res.status(400).json({ error: "Bad request" });
+  }
+});
+
+/**
+ * Handle all POST requests.
+ * event.req.body contains the parsed JSON body (Express json() middleware is pre-configured).
+ */
+apiInput.event.on("apiPostEvent", (event: UnsEvents["apiPostEvent"]) => {
+  try {
+    const body = event.req.body as { value?: number; unit?: string };
+    // Add your write/command logic here
+    event.res.json({ status: "ok", received: body });
+  } catch (error) {
+    event.res.status(400).json({ error: "Bad request" });
+  }
+});
+
+// ─── NOTE: registerCatchAll ───────────────────────────────────────────────────
+//
+// registerCatchAll() is used ONLY by the uns-api-global microservice, which acts
+// as a catch-all gateway for an entire topic namespace. Regular microservices
+// do NOT call this — use get() / post() above for per-attribute endpoints.

package/templates/azure-pipelines.yml

@@ -1,21 +1,21 @@
-variables:
-  privatePool: 'Azure private pool'
-
-trigger:
-- master
-
-stages:
-- stage: version_tag
-  displayName: Add Version Tag
-  pool: $(privatePool)
-  jobs:
-  - job: add_tags
-    steps:
-    - checkout: self
-      persistCredentials: true
-      clean: true
-    - script: |
-        tag=$(node -pe "require('./package.json').version")
-        git tag $tag
-        git push origin $tag
-      displayName: "Add version tag from package.json"
+variables:
+  privatePool: 'Azure private pool'
+
+trigger:
+- master
+
+stages:
+- stage: version_tag
+  displayName: Add Version Tag
+  pool: $(privatePool)
+  jobs:
+  - job: add_tags
+    steps:
+    - checkout: self
+      persistCredentials: true
+      clean: true
+    - script: |
+        tag=$(node -pe "require('./package.json').version")
+        git tag $tag
+        git push origin $tag
+      displayName: "Add version tag from package.json"

package/templates/codegen/codegen.ts

@@ -1,15 +1,15 @@
-import type { CodegenConfig } from '@graphql-codegen/cli';
-import { ConfigFile } from '@uns-kit/core';
-
-const appConfig = await ConfigFile.loadConfig();
-
-const config: CodegenConfig = {
-  schema: appConfig.uns.graphql,
-  generates: {
-    'src/graphql/schema.ts': {
-      plugins: ['typescript', 'typescript-operations', 'typescript-resolvers'],
-    },
-  },
-};
-
-export default config;
+import type { CodegenConfig } from '@graphql-codegen/cli';
+import { ConfigFile } from '@uns-kit/core';
+
+const appConfig = await ConfigFile.loadConfig();
+
+const config: CodegenConfig = {
+  schema: appConfig.uns.graphql,
+  generates: {
+    'src/graphql/schema.ts': {
+      plugins: ['typescript', 'typescript-operations', 'typescript-resolvers'],
+    },
+  },
+};
+
+export default config;

package/templates/codegen/src/uns/uns-tags.ts

@@ -1 +1 @@
-export type UnsTags = string & {};
+export type UnsTags = string & {};

package/templates/codegen/src/uns/uns-topics.ts

@@ -1 +1 @@
-export type UnsTopics = string & {};
+export type UnsTopics = string & {};

package/templates/config-files/config-docker.json

@@ -1,35 +1,35 @@
-{
-  "uns": {
-    "graphql": "http://uns-datahub-controller:3200/graphql",
-    "rest": "http://uns-datahub-controller:3200/api",
-    "processName": "__APP_NAME__",
-    "supervisor": {
-      "enabled": false,
-      "restartOnExit": false,
-      "maxMemoryMb": 512,
-      "restartOnUnhealthy": false,
-      "unhealthyAfterMs": 60000,
-      "restartCooldownMs": 300000
-    },
-    "instanceMode": "wait",
-    "handover": true,
-    "jwksWellKnownUrl": "http://uns-datahub-controller:3200/api/.well-known/jwks.json",
-    "kidWellKnownUrl": "http://uns-datahub-controller:3200/api/.well-known/kid",
+{
+  "uns": {
+    "graphql": "http://uns-datahub-controller:3200/graphql",
+    "rest": "http://uns-datahub-controller:3200/api",
+    "processName": "__APP_NAME__",
+    "supervisor": {
+      "enabled": false,
+      "restartOnExit": false,
+      "maxMemoryMb": 512,
+      "restartOnUnhealthy": false,
+      "unhealthyAfterMs": 60000,
+      "restartCooldownMs": 300000
+    },
+    "instanceMode": "wait",
+    "handover": true,
+    "jwksWellKnownUrl": "http://uns-datahub-controller:3200/api/.well-known/jwks.json",
+    "kidWellKnownUrl": "http://uns-datahub-controller:3200/api/.well-known/kid",
     "email": "user@example-org.com",
     "password": "secret"
   },
-  "infra": {
-    "host": "mosquitto:1883"
-  },
-  "output": {
-    "host": "mosquitto:1883"
-  },
-  "input": {
-    "host": "mosquitto:1883"
-  },
-  "devops": {
-    "provider": "azure-devops",
-    "organization": "example-org",
-    "project": "example-project"
-  }
-}
+  "infra": {
+    "host": "mosquitto:1883"
+  },
+  "output": {
+    "host": "mosquitto:1883"
+  },
+  "input": {
+    "host": "mosquitto:1883"
+  },
+  "devops": {
+    "provider": "azure-devops",
+    "organization": "example-org",
+    "project": "example-project"
+  }
+}

package/templates/config-files/config-localhost.json

@@ -1,35 +1,35 @@
-{
-  "uns": {
-    "graphql": "http://localhost:3200/graphql",
-    "rest": "http://localhost:3200/api",
-    "processName": "__APP_NAME__",
-    "supervisor": {
-      "enabled": false,
-      "restartOnExit": false,
-      "maxMemoryMb": 512,
-      "restartOnUnhealthy": false,
-      "unhealthyAfterMs": 60000,
-      "restartCooldownMs": 300000
-    },
-    "instanceMode": "wait",
-    "handover": true,
-    "jwksWellKnownUrl": "http://localhost:3200/api/.well-known/jwks.json",
-    "kidWellKnownUrl": "http://localhost:3200/api/.well-known/kid",
+{
+  "uns": {
+    "graphql": "http://localhost:3200/graphql",
+    "rest": "http://localhost:3200/api",
+    "processName": "__APP_NAME__",
+    "supervisor": {
+      "enabled": false,
+      "restartOnExit": false,
+      "maxMemoryMb": 512,
+      "restartOnUnhealthy": false,
+      "unhealthyAfterMs": 60000,
+      "restartCooldownMs": 300000
+    },
+    "instanceMode": "wait",
+    "handover": true,
+    "jwksWellKnownUrl": "http://localhost:3200/api/.well-known/jwks.json",
+    "kidWellKnownUrl": "http://localhost:3200/api/.well-known/kid",
     "email": "user@example-org.com",
     "password": "secret"
   },
-  "infra": {
-    "host": "localhost"
-  },
-  "output": {
-    "host": "localhost"
-  },
-  "input": {
-    "host": "localhost"
-  },
-  "devops": {
-    "provider": "azure-devops",
-    "organization": "example-org",
-    "project": "example-project"
-  }
-}
+  "infra": {
+    "host": "localhost"
+  },
+  "output": {
+    "host": "localhost"
+  },
+  "input": {
+    "host": "localhost"
+  },
+  "devops": {
+    "provider": "azure-devops",
+    "organization": "example-org",
+    "project": "example-project"
+  }
+}

package/templates/cron/AGENTS.md

@@ -1,20 +1,20 @@
-# Agent Onboarding (template)
-
-Pointers for AI/code-assist tools when working in this generated project.
-
-## What to read locally
-
-- `package.json` for scripts (`sync-uns-*`, `generate-codegen`, etc.).
-- `config.schema.json` for the app config shape; `processName` is required.
-- `src/examples/*.ts` for cron-driven publish patterns and description registration.
-- Installed docs (under `node_modules`):
-  - `@uns-kit/core/README.md`
-  - `@uns-kit/api/README.md` (if installed)
-  - `@uns-kit/cron/README.md` (if installed)
-  - `@uns-kit/cli/README.md` (if installed)
-
-## Generators in this project
-
-- `pnpm run generate-codegen` -> GraphQL codegen (after configure-codegen)
-- `pnpm run sync-uns-schema -- --controller-url ... --token ...` -> pulls `uns-dictionary.json` + `uns-measurements.json` from the controller and regenerates local TS helpers
-- `pnpm run sync-uns-metadata -- --controller-url ... --token ...` -> pulls topics/tags/assets from the controller and regenerates local TS helpers
+# Agent Onboarding (template)
+
+Pointers for AI/code-assist tools when working in this generated project.
+
+## What to read locally
+
+- `package.json` for scripts (`sync-uns-*`, `generate-codegen`, etc.).
+- `config.schema.json` for the app config shape; `processName` is required.
+- `src/examples/*.ts` for cron-driven publish patterns and description registration.
+- Installed docs (under `node_modules`):
+  - `@uns-kit/core/README.md`
+  - `@uns-kit/api/README.md` (if installed)
+  - `@uns-kit/cron/README.md` (if installed)
+  - `@uns-kit/cli/README.md` (if installed)
+
+## Generators in this project
+
+- `pnpm run generate-codegen` -> GraphQL codegen (after configure-codegen)
+- `pnpm run sync-uns-schema -- --controller-url ... --token ...` -> pulls `uns-dictionary.json` + `uns-measurements.json` from the controller and regenerates local TS helpers
+- `pnpm run sync-uns-metadata -- --controller-url ... --token ...` -> pulls topics/tags/assets from the controller and regenerates local TS helpers