@xemahq/contracts 0.26.0 → 0.28.0

package/dist/resource-requirement/lib/resource-requirement.d.ts

@@ -0,0 +1,59 @@
+import { PeerInclusionKind } from '../../biome-dependency';
+import { SpaceKind } from '../../space';
+import { z } from 'zod';
+export declare const RESOURCE_KIND_REF_PATTERN: RegExp;
+export declare const RESOURCE_KIND_REF_MAX_LENGTH = 128;
+export declare const ResourceKindRefSchema: z.ZodString;
+export type ResourceKindRef = z.infer<typeof ResourceKindRefSchema>;
+export declare const RESOURCE_LOGICAL_NAME_PATTERN: RegExp;
+export declare const RESOURCE_LOGICAL_NAME_MAX_LENGTH = 63;
+export declare const ResourceLogicalNameSchema: z.ZodString;
+export type ResourceLogicalName = z.infer<typeof ResourceLogicalNameSchema>;
+export declare const RESOURCE_SCOPE_SPACE_KINDS: import("../../space").SpaceKindSubset;
+export declare const ResourceScopeSchema: z.ZodEnum<{
+    system: SpaceKind.System;
+    org: SpaceKind.Org;
+}>;
+export type ResourceScope = z.infer<typeof ResourceScopeSchema>;
+export declare const ResourceInclusionSchema: z.ZodEnum<{
+    required: PeerInclusionKind.Required;
+    optional: PeerInclusionKind.Optional;
+}>;
+export type ResourceInclusion = z.infer<typeof ResourceInclusionSchema>;
+export declare const RESOURCE_SYSTEM_SCOPE_REASON_MIN_CHARS = 200;
+export declare const RESOURCE_SYSTEM_SCOPE_EMPTY_REASONS: readonly string[];
+export declare const ResourceRequirementSchema: z.ZodObject<{
+    kind: z.ZodString;
+    logicalName: z.ZodString;
+    scope: z.ZodEnum<{
+        system: SpaceKind.System;
+        org: SpaceKind.Org;
+    }>;
+    inclusion: z.ZodEnum<{
+        required: PeerInclusionKind.Required;
+        optional: PeerInclusionKind.Optional;
+    }>;
+    whyNotOrgScoped: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type ResourceRequirement = z.infer<typeof ResourceRequirementSchema>;
+export declare const ResourceRequirementsSchema: z.ZodArray<z.ZodObject<{
+    kind: z.ZodString;
+    logicalName: z.ZodString;
+    scope: z.ZodEnum<{
+        system: SpaceKind.System;
+        org: SpaceKind.Org;
+    }>;
+    inclusion: z.ZodEnum<{
+        required: PeerInclusionKind.Required;
+        optional: PeerInclusionKind.Optional;
+    }>;
+    whyNotOrgScoped: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>>;
+export declare const ResourceProvisionSchema: z.ZodObject<{
+    kind: z.ZodString;
+}, z.core.$strict>;
+export type ResourceProvision = z.infer<typeof ResourceProvisionSchema>;
+export declare const ResourceProvisionsSchema: z.ZodArray<z.ZodObject<{
+    kind: z.ZodString;
+}, z.core.$strict>>;
+//# sourceMappingURL=resource-requirement.d.ts.map

package/dist/resource-requirement/lib/resource-requirement.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource-requirement.d.ts","sourceRoot":"","sources":["../../../src/resource-requirement/lib/resource-requirement.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAmB,MAAM,aAAa,CAAC;AACzD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAqCxB,eAAO,MAAM,yBAAyB,QACiC,CAAC;AAGxE,eAAO,MAAM,4BAA4B,MAAM,CAAC;AAEhD,eAAO,MAAM,qBAAqB,aAM/B,CAAC;AAEJ,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAOpE,eAAO,MAAM,6BAA6B,QAAoC,CAAC;AAG/E,eAAO,MAAM,gCAAgC,KAAK,CAAC;AAEnD,eAAO,MAAM,yBAAyB,aAMnC,CAAC;AACJ,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAY5E,eAAO,MAAM,0BAA0B,uCAGtC,CAAC;AAEF,eAAO,MAAM,mBAAmB;;;EAA4C,CAAC;AAC7E,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAiBhE,eAAO,MAAM,uBAAuB;;;EAGlC,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAaxE,eAAO,MAAM,sCAAsC,MAAM,CAAC;AAO1D,eAAO,MAAM,mCAAmC,EAAE,SAAS,MAAM,EAS7D,CAAC;AAGL,eAAO,MAAM,yBAAyB;;;;;;;;;;;;kBAoDlC,CAAC;AACL,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAU5E,eAAO,MAAM,0BAA0B;;;;;;;;;;;;mBAenC,CAAC;AAOL,eAAO,MAAM,uBAAuB;;kBAIzB,CAAC;AACZ,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAGxE,eAAO,MAAM,wBAAwB;;mBAcjC,CAAC"}

package/dist/resource-requirement/lib/resource-requirement.js

@@ -0,0 +1,116 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResourceProvisionsSchema = exports.ResourceProvisionSchema = exports.ResourceRequirementsSchema = exports.ResourceRequirementSchema = exports.RESOURCE_SYSTEM_SCOPE_EMPTY_REASONS = exports.RESOURCE_SYSTEM_SCOPE_REASON_MIN_CHARS = exports.ResourceInclusionSchema = exports.ResourceScopeSchema = exports.RESOURCE_SCOPE_SPACE_KINDS = exports.ResourceLogicalNameSchema = exports.RESOURCE_LOGICAL_NAME_MAX_LENGTH = exports.RESOURCE_LOGICAL_NAME_PATTERN = exports.ResourceKindRefSchema = exports.RESOURCE_KIND_REF_MAX_LENGTH = exports.RESOURCE_KIND_REF_PATTERN = void 0;
+const biome_dependency_1 = require("../../biome-dependency");
+const space_1 = require("../../space");
+const zod_1 = require("zod");
+exports.RESOURCE_KIND_REF_PATTERN = /^[a-z][a-z0-9]*(?:-[a-z0-9]+)*(?:\.[a-z][a-z0-9]*(?:-[a-z0-9]+)*)+$/;
+exports.RESOURCE_KIND_REF_MAX_LENGTH = 128;
+exports.ResourceKindRefSchema = zod_1.z
+    .string()
+    .max(exports.RESOURCE_KIND_REF_MAX_LENGTH)
+    .regex(exports.RESOURCE_KIND_REF_PATTERN, 'a resource kind is a dotted lowercase identifier of at least two segments, e.g. "redis.namespace"');
+exports.RESOURCE_LOGICAL_NAME_PATTERN = /^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$/;
+exports.RESOURCE_LOGICAL_NAME_MAX_LENGTH = 63;
+exports.ResourceLogicalNameSchema = zod_1.z
+    .string()
+    .max(exports.RESOURCE_LOGICAL_NAME_MAX_LENGTH)
+    .regex(exports.RESOURCE_LOGICAL_NAME_PATTERN, 'a resource logical name is lowercase kebab-case, e.g. "session-cache"');
+exports.RESOURCE_SCOPE_SPACE_KINDS = (0, space_1.spaceKindSubset)(space_1.SpaceKind.System, space_1.SpaceKind.Org);
+exports.ResourceScopeSchema = zod_1.z.enum([space_1.SpaceKind.System, space_1.SpaceKind.Org]);
+exports.ResourceInclusionSchema = zod_1.z.enum([
+    biome_dependency_1.PeerInclusionKind.Required,
+    biome_dependency_1.PeerInclusionKind.Optional,
+]);
+exports.RESOURCE_SYSTEM_SCOPE_REASON_MIN_CHARS = 200;
+exports.RESOURCE_SYSTEM_SCOPE_EMPTY_REASONS = Object.freeze([
+    'system',
+    'system data',
+    'platform data',
+    'no org',
+    'not tenant scoped',
+    'n/a',
+    'tbd',
+]);
+exports.ResourceRequirementSchema = zod_1.z
+    .object({
+    kind: exports.ResourceKindRefSchema,
+    logicalName: exports.ResourceLogicalNameSchema,
+    scope: exports.ResourceScopeSchema,
+    inclusion: exports.ResourceInclusionSchema,
+    whyNotOrgScoped: zod_1.z.string().optional(),
+})
+    .strict()
+    .superRefine((requirement, ctx) => {
+    if (requirement.scope === space_1.SpaceKind.Org) {
+        if (requirement.whyNotOrgScoped !== undefined) {
+            ctx.addIssue({
+                code: 'custom',
+                path: ['whyNotOrgScoped'],
+                message: 'whyNotOrgScoped is only valid on a system-scoped resource — an org-scoped resource needs no justification',
+            });
+        }
+        return;
+    }
+    const reason = requirement.whyNotOrgScoped?.trim();
+    if (reason === undefined || reason.length === 0) {
+        ctx.addIssue({
+            code: 'custom',
+            path: ['whyNotOrgScoped'],
+            message: 'a system-scoped resource must declare whyNotOrgScoped — state why an org-scoped resource would not do; a system resource is shared by every org in the installation',
+        });
+        return;
+    }
+    if (exports.RESOURCE_SYSTEM_SCOPE_EMPTY_REASONS.includes(reason.toLowerCase())) {
+        ctx.addIssue({
+            code: 'custom',
+            path: ['whyNotOrgScoped'],
+            message: `whyNotOrgScoped is boilerplate ("${reason}") — state why an org-scoped resource would not do`,
+        });
+        return;
+    }
+    if (reason.length < exports.RESOURCE_SYSTEM_SCOPE_REASON_MIN_CHARS) {
+        ctx.addIssue({
+            code: 'custom',
+            path: ['whyNotOrgScoped'],
+            message: `whyNotOrgScoped is ${reason.length} characters; at least ${exports.RESOURCE_SYSTEM_SCOPE_REASON_MIN_CHARS} are required — state why an org-scoped resource would not do`,
+        });
+    }
+});
+exports.ResourceRequirementsSchema = zod_1.z
+    .array(exports.ResourceRequirementSchema)
+    .superRefine((requirements, ctx) => {
+    const seen = new Set();
+    requirements.forEach((requirement, index) => {
+        const key = `${requirement.kind}\0${requirement.logicalName}`;
+        if (seen.has(key)) {
+            ctx.addIssue({
+                code: 'custom',
+                path: [index, 'logicalName'],
+                message: `duplicate resource requirement ${requirement.kind} "${requirement.logicalName}"`,
+            });
+        }
+        seen.add(key);
+    });
+});
+exports.ResourceProvisionSchema = zod_1.z
+    .object({
+    kind: exports.ResourceKindRefSchema,
+})
+    .strict();
+exports.ResourceProvisionsSchema = zod_1.z
+    .array(exports.ResourceProvisionSchema)
+    .superRefine((provisions, ctx) => {
+    const seen = new Set();
+    provisions.forEach((provision, index) => {
+        if (seen.has(provision.kind)) {
+            ctx.addIssue({
+                code: 'custom',
+                path: [index, 'kind'],
+                message: `duplicate provided resource kind "${provision.kind}"`,
+            });
+        }
+        seen.add(provision.kind);
+    });
+});
+//# sourceMappingURL=resource-requirement.js.map

package/dist/resource-requirement/lib/resource-requirement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource-requirement.js","sourceRoot":"","sources":["../../../src/resource-requirement/lib/resource-requirement.ts"],"names":[],"mappings":";;;AAAA,6DAA2D;AAC3D,uCAAyD;AACzD,6BAAwB;AAqCX,QAAA,yBAAyB,GACpC,qEAAqE,CAAC;AAG3D,QAAA,4BAA4B,GAAG,GAAG,CAAC;AAEnC,QAAA,qBAAqB,GAAG,OAAC;KACnC,MAAM,EAAE;KACR,GAAG,CAAC,oCAA4B,CAAC;KACjC,KAAK,CACJ,iCAAyB,EACzB,mGAAmG,CACpG,CAAC;AASS,QAAA,6BAA6B,GAAG,iCAAiC,CAAC;AAGlE,QAAA,gCAAgC,GAAG,EAAE,CAAC;AAEtC,QAAA,yBAAyB,GAAG,OAAC;KACvC,MAAM,EAAE;KACR,GAAG,CAAC,wCAAgC,CAAC;KACrC,KAAK,CACJ,qCAA6B,EAC7B,uEAAuE,CACxE,CAAC;AAaS,QAAA,0BAA0B,GAAG,IAAA,uBAAe,EACvD,iBAAS,CAAC,MAAM,EAChB,iBAAS,CAAC,GAAG,CACd,CAAC;AAEW,QAAA,mBAAmB,GAAG,OAAC,CAAC,IAAI,CAAC,CAAC,iBAAS,CAAC,MAAM,EAAE,iBAAS,CAAC,GAAG,CAAC,CAAC,CAAC;AAkBhE,QAAA,uBAAuB,GAAG,OAAC,CAAC,IAAI,CAAC;IAC5C,oCAAiB,CAAC,QAAQ;IAC1B,oCAAiB,CAAC,QAAQ;CAC3B,CAAC,CAAC;AAcU,QAAA,sCAAsC,GAAG,GAAG,CAAC;AAO7C,QAAA,mCAAmC,GAC9C,MAAM,CAAC,MAAM,CAAC;IACZ,QAAQ;IACR,aAAa;IACb,eAAe;IACf,QAAQ;IACR,mBAAmB;IACnB,KAAK;IACL,KAAK;CACN,CAAC,CAAC;AAGQ,QAAA,yBAAyB,GAAG,OAAC;KACvC,MAAM,CAAC;IACN,IAAI,EAAE,6BAAqB;IAC3B,WAAW,EAAE,iCAAyB;IACtC,KAAK,EAAE,2BAAmB;IAC1B,SAAS,EAAE,+BAAuB;IAOlC,eAAe,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACvC,CAAC;KACD,MAAM,EAAE;KACR,WAAW,CAAC,CAAC,WAAW,EAAE,GAAG,EAAE,EAAE;IAChC,IAAI,WAAW,CAAC,KAAK,KAAK,iBAAS,CAAC,GAAG,EAAE,CAAC;QACxC,IAAI,WAAW,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YAC9C,GAAG,CAAC,QAAQ,CAAC;gBACX,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,CAAC,iBAAiB,CAAC;gBACzB,OAAO,EACL,2GAA2G;aAC9G,CAAC,CAAC;QACL,CAAC;QACD,OAAO;IACT,CAAC;IACD,MAAM,MAAM,GAAG,WAAW,CAAC,eAAe,EAAE,IAAI,EAAE,CAAC;IACnD,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChD,GAAG,CAAC,QAAQ,CAAC;YACX,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,iBAAiB,CAAC;YACzB,OAAO,EACL,qKAAqK;SACxK,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IACD,IAAI,2CAAmC,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;QACvE,GAAG,CAAC,QAAQ,CAAC;YACX,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,iBAAiB,CAAC;YACzB,OAAO,EAAE,oCAAoC,MAAM,oDAAoD;SACxG,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,GAAG,8CAAsC,EAAE,CAAC;QAC3D,GAAG,CAAC,QAAQ,CAAC;YACX,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,iBAAiB,CAAC;YACzB,OAAO,EAAE,sBAAsB,MAAM,CAAC,MAAM,yBAAyB,8CAAsC,+DAA+D;SAC3K,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC,CAAC;AAWQ,QAAA,0BAA0B,GAAG,OAAC;KACxC,KAAK,CAAC,iCAAyB,CAAC;KAChC,WAAW,CAAC,CAAC,YAAY,EAAE,GAAG,EAAE,EAAE;IACjC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,YAAY,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,KAAK,EAAE,EAAE;QAC1C,MAAM,GAAG,GAAG,GAAG,WAAW,CAAC,IAAI,KAAK,WAAW,CAAC,WAAW,EAAE,CAAC;QAC9D,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAClB,GAAG,CAAC,QAAQ,CAAC;gBACX,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,CAAC,KAAK,EAAE,aAAa,CAAC;gBAC5B,OAAO,EAAE,kCAAkC,WAAW,CAAC,IAAI,KAAK,WAAW,CAAC,WAAW,GAAG;aAC3F,CAAC,CAAC;QACL,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAOQ,QAAA,uBAAuB,GAAG,OAAC;KACrC,MAAM,CAAC;IACN,IAAI,EAAE,6BAAqB;CAC5B,CAAC;KACD,MAAM,EAAE,CAAC;AAIC,QAAA,wBAAwB,GAAG,OAAC;KACtC,KAAK,CAAC,+BAAuB,CAAC;KAC9B,WAAW,CAAC,CAAC,UAAU,EAAE,GAAG,EAAE,EAAE;IAC/B,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,UAAU,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE;QACtC,IAAI,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7B,GAAG,CAAC,QAAQ,CAAC;gBACX,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC;gBACrB,OAAO,EAAE,qCAAqC,SAAS,CAAC,IAAI,GAAG;aAChE,CAAC,CAAC;QACL,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xemahq/contracts",
-  "version": "0.26.0",
+  "version": "0.28.0",
   "description": "Consolidated Xema OS kernel wire contracts — pure types + zod schemas for the kernel protocol surfaces. One package, one npm scope, wildcard per-surface subpath exports. No framework/runtime deps.",
   "license": "Apache-2.0",
   "author": "Neuralchowder Inc. <developer@xema.dev> (https://xema.dev)",