@campfire-interactive/master-data-client 5.10.1 → 5.11.0

package/dist/workSteps.js

@@ -0,0 +1,168 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkingCalendarResource = exports.WorkStepEpisodeResource = exports.WorkStepDefinitionResource = void 0;
+// The timeliness ledger. Tenant-scoped server-side; the tenant frame comes from
+// the request's auth, so no tenantId is passed here.
+/**
+ * What each step is and how long it should take. Reads never create rows: a
+ * tenant that has saved nothing still resolves every step from the platform
+ * defaults (`customized: false`, `id: null`).
+ */
+class WorkStepDefinitionResource {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    async list(options) {
+        return this.http.request({
+            method: 'GET',
+            path: '/v1/work-step-definitions',
+            query: {
+                subjectKind: options?.subjectKind,
+                variant: options?.variant,
+                includeInactive: options?.includeInactive ? 'true' : undefined,
+            },
+        });
+    }
+    /** Save a kind's overrides atomically (owner/admin). Replaying the same save is a no-op. */
+    async save(input, idempotencyKey) {
+        return this.http.request({
+            method: 'PUT',
+            path: '/v1/work-step-definitions',
+            body: input,
+            idempotencyKey,
+        });
+    }
+    /** Copy the platform defaults into the tenant's own rows (owner/admin). Idempotent. */
+    async populateDefaults(subjectKind, variant) {
+        return this.http.request({
+            method: 'POST',
+            path: '/v1/work-step-definitions/populate-defaults',
+            body: { subjectKind, variant },
+        });
+    }
+}
+exports.WorkStepDefinitionResource = WorkStepDefinitionResource;
+/**
+ * Executions of steps. Every write names the `callerRole` it is made on behalf
+ * of; the server checks it against the subject kind (quote: cpq/omsf/admin,
+ * vehicle_program: cpq/admin, launch_program: pm/admin).
+ */
+class WorkStepEpisodeResource {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /** Keyset feed ordered by (updatedAt, id), for the analytics extract and for sweeps. */
+    async list(options) {
+        return this.http.request({
+            method: 'GET',
+            path: '/v1/work-step-episodes',
+            query: {
+                updatedSince: options?.updatedSince,
+                subjectType: options?.subjectType,
+                stepCode: options?.stepCode,
+                limit: options?.limit !== undefined ? String(options.limit) : undefined,
+                cursor: options?.cursor,
+            },
+        });
+    }
+    /** One entry per (child, step) with the latest iteration and derived state. */
+    async getSeries(subjectType, subjectId) {
+        return this.http.request({
+            method: 'GET',
+            path: `/v1/work-step-episodes/subjects/${encodeURIComponent(subjectType)}/${encodeURIComponent(subjectId)}`,
+        });
+    }
+    /**
+     * Open a step. Idempotent: opening an already-open step returns it untouched,
+     * so a duplicated event cannot restart the clock. A done step is a 409 -
+     * that is {@link reopen}. The iteration is server-assigned.
+     */
+    async open(input, idempotencyKey) {
+        return this.http.request({
+            method: 'POST',
+            path: '/v1/work-step-episodes/open',
+            body: input,
+            idempotencyKey,
+        });
+    }
+    /**
+     * Close the latest iteration. Idempotent on a done step. Closing a step that
+     * was never opened records a single-ended fact with certainty `recorded`.
+     */
+    async close(input, idempotencyKey) {
+        return this.http.request({
+            method: 'POST',
+            path: '/v1/work-step-episodes/close',
+            body: input,
+            idempotencyKey,
+        });
+    }
+    /** Start a new iteration of a done step. `reopenReason` is required. */
+    async reopen(input, idempotencyKey) {
+        return this.http.request({
+            method: 'POST',
+            path: '/v1/work-step-episodes/reopen',
+            body: input,
+            idempotencyKey,
+        });
+    }
+    /**
+     * Upsert up to 500 episodes on their natural key. Idempotent: an unchanged
+     * row is not written (so `updatedAt` does not move), and a stale replay never
+     * regresses a done row. This is how an app reports history it already holds
+     * (omsf's approval chains, cpq's cutover replay) and how a sweep re-emits.
+     */
+    async batch(input, idempotencyKey) {
+        return this.http.request({
+            method: 'POST',
+            path: '/v1/work-step-episodes/batch',
+            body: input,
+            idempotencyKey,
+        });
+    }
+}
+exports.WorkStepEpisodeResource = WorkStepEpisodeResource;
+/** A plant's working week and its exceptions. A plant with no calendar is Monday-Friday. */
+class WorkingCalendarResource {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    async list() {
+        return this.http.request({ method: 'GET', path: '/v1/working-calendars' });
+    }
+    async get(productionSourceId) {
+        return this.http.request({
+            method: 'GET',
+            path: `/v1/working-calendars/${encodeURIComponent(productionSourceId)}`,
+        });
+    }
+    /** Create or update a plant's calendar (owner/admin). An empty `workingDays` is a 422. */
+    async upsert(productionSourceId, input, idempotencyKey) {
+        return this.http.request({
+            method: 'PUT',
+            path: `/v1/working-calendars/${encodeURIComponent(productionSourceId)}`,
+            body: input,
+            idempotencyKey,
+        });
+    }
+    /** Add or replace the override for one date (owner/admin). Idempotent on (plant, date). */
+    async putException(productionSourceId, input, idempotencyKey) {
+        return this.http.request({
+            method: 'PUT',
+            path: `/v1/working-calendars/${encodeURIComponent(productionSourceId)}/exceptions`,
+            body: input,
+            idempotencyKey,
+        });
+    }
+    async deleteException(productionSourceId, date) {
+        await this.http.request({
+            method: 'DELETE',
+            path: `/v1/working-calendars/${encodeURIComponent(productionSourceId)}/exceptions/${encodeURIComponent(date)}`,
+        });
+    }
+}
+exports.WorkingCalendarResource = WorkingCalendarResource;
+//# sourceMappingURL=workSteps.js.map

package/dist/workSteps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workSteps.js","sourceRoot":"","sources":["../src/workSteps.ts"],"names":[],"mappings":";;;AAuBA,gFAAgF;AAChF,qDAAqD;AAErD;;;;GAIG;AACH,MAAa,0BAA0B;IACR;IAA7B,YAA6B,IAAmB;QAAnB,SAAI,GAAJ,IAAI,CAAe;IAAG,CAAC;IAEpD,KAAK,CAAC,IAAI,CAAC,OAAwC;QACjD,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAmC;YACzD,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,2BAA2B;YACjC,KAAK,EAAE;gBACL,WAAW,EAAE,OAAO,EAAE,WAAW;gBACjC,OAAO,EAAE,OAAO,EAAE,OAAO;gBACzB,eAAe,EAAE,OAAO,EAAE,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;aAC/D;SACF,CAAC,CAAC;IACL,CAAC;IAED,4FAA4F;IAC5F,KAAK,CAAC,IAAI,CACR,KAAmC,EACnC,cAAuB;QAEvB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAmC;YACzD,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,2BAA2B;YACjC,IAAI,EAAE,KAAK;YACX,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED,uFAAuF;IACvF,KAAK,CAAC,gBAAgB,CACpB,WAAgC,EAChC,OAAgB;QAEhB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAsC;YAC5D,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,6CAA6C;YACnD,IAAI,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE;SAC/B,CAAC,CAAC;IACL,CAAC;CACF;AAvCD,gEAuCC;AAED;;;;GAIG;AACH,MAAa,uBAAuB;IACL;IAA7B,YAA6B,IAAmB;QAAnB,SAAI,GAAJ,IAAI,CAAe;IAAG,CAAC;IAEpD,wFAAwF;IACxF,KAAK,CAAC,IAAI,CAAC,OAAqC;QAC9C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAgC;YACtD,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,wBAAwB;YAC9B,KAAK,EAAE;gBACL,YAAY,EAAE,OAAO,EAAE,YAAY;gBACnC,WAAW,EAAE,OAAO,EAAE,WAAW;gBACjC,QAAQ,EAAE,OAAO,EAAE,QAAQ;gBAC3B,KAAK,EAAE,OAAO,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS;gBACvE,MAAM,EAAE,OAAO,EAAE,MAAM;aACxB;SACF,CAAC,CAAC;IACL,CAAC;IAED,+EAA+E;IAC/E,KAAK,CAAC,SAAS,CACb,WAAgC,EAChC,SAAiB;QAEjB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAoC;YAC1D,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,mCAAmC,kBAAkB,CAAC,WAAW,CAAC,IAAI,kBAAkB,CAAC,SAAS,CAAC,EAAE;SAC5G,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAI,CAAC,KAAwB,EAAE,cAAuB;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAkC;YACxD,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,6BAA6B;YACnC,IAAI,EAAE,KAAK;YACX,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,KAAK,CAAC,KAAyB,EAAE,cAAuB;QAC5D,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAkC;YACxD,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,8BAA8B;YACpC,IAAI,EAAE,KAAK;YACX,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED,wEAAwE;IACxE,KAAK,CAAC,MAAM,CAAC,KAA0B,EAAE,cAAuB;QAC9D,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAkC;YACxD,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,+BAA+B;YACrC,IAAI,EAAE,KAAK;YACX,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CAAC,KAAiC,EAAE,cAAuB;QACpE,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAA8C;YACpE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,8BAA8B;YACpC,IAAI,EAAE,KAAK;YACX,cAAc;SACf,CAAC,CAAC;IACL,CAAC;CACF;AAhFD,0DAgFC;AAED,4FAA4F;AAC5F,MAAa,uBAAuB;IACL;IAA7B,YAA6B,IAAmB;QAAnB,SAAI,GAAJ,IAAI,CAAe;IAAG,CAAC;IAEpD,KAAK,CAAC,IAAI;QACR,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAgC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,kBAA0B;QAClC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAkC;YACxD,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,yBAAyB,kBAAkB,CAAC,kBAAkB,CAAC,EAAE;SACxE,CAAC,CAAC;IACL,CAAC;IAED,0FAA0F;IAC1F,KAAK,CAAC,MAAM,CACV,kBAA0B,EAC1B,KAAiC,EACjC,cAAuB;QAEvB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAkC;YACxD,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,yBAAyB,kBAAkB,CAAC,kBAAkB,CAAC,EAAE;YACvE,IAAI,EAAE,KAAK;YACX,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED,2FAA2F;IAC3F,KAAK,CAAC,YAAY,CAChB,kBAA0B,EAC1B,KAAuC,EACvC,cAAuB;QAEvB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAA2C;YACjE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,yBAAyB,kBAAkB,CAAC,kBAAkB,CAAC,aAAa;YAClF,IAAI,EAAE,KAAK;YACX,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,kBAA0B,EAAE,IAAY;QAC5D,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAY;YACjC,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,yBAAyB,kBAAkB,CAAC,kBAAkB,CAAC,eAAe,kBAAkB,CAAC,IAAI,CAAC,EAAE;SAC/G,CAAC,CAAC;IACL,CAAC;CACF;AAhDD,0DAgDC"}

package/package.json

@@ -1,31 +1,31 @@
-{
-  "name": "@campfire-interactive/master-data-client",
-  "version": "5.10.1",
-  "description": "TypeScript client for the Master Data Service",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "build": "tsc",
-    "clean": "rm -rf dist",
-    "test": "npm run build && node --test",
-    "prepublishOnly": "npm run build"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Campfire-Interactive/packages.git"
-  },
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org",
-    "access": "public"
-  },
-  "devDependencies": {
-    "@types/node": "^25.5.0",
-    "typescript": "^5.3.3"
-  },
-  "engines": {
-    "node": ">=18.0.0"
-  }
-}
+{
+  "name": "@campfire-interactive/master-data-client",
+  "version": "5.11.0",
+  "description": "TypeScript client for the Master Data Service",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "test": "npm run build && node --test",
+    "prepublishOnly": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Campfire-Interactive/packages.git"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/node": "^25.5.0",
+    "typescript": "^5.3.3"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}