@xemahq/kernel-contracts 0.24.0 → 0.25.0

package/LICENSE

@@ -0,0 +1,176 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/dist/contribution/lib/contribution-kind.d.ts

@@ -29,7 +29,8 @@ export declare enum ContributionKind {
     OpenCodePlugin = "opencode-plugin",
     Capability = "capability",
     ResourceOwnership = "resource-ownership",
-    StageMachine = "stage-machine"
+    StageMachine = "stage-machine",
+    SearchType = "search-type"
 }
 export declare const ContributionKindSchema: z.ZodEnum<typeof ContributionKind>;
 export type ContributionKindValue = `${ContributionKind}`;

package/dist/contribution/lib/contribution-kind.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"contribution-kind.d.ts","sourceRoot":"","sources":["../../../src/contribution/lib/contribution-kind.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAoBxB,oBAAY,gBAAgB;IAE1B,WAAW,iBAAiB;IAC5B,OAAO,aAAa;IACpB,YAAY,kBAAkB;IAC9B,UAAU,gBAAgB;IAC1B,YAAY,kBAAkB;IAC9B,UAAU,gBAAgB;IAC1B,WAAW,iBAAiB;IAC5B,wBAAwB,+BAA+B;IACvD,UAAU,gBAAgB;IAQ1B,YAAY,kBAAkB;IAM9B,WAAW,iBAAiB;IAW5B,cAAc,oBAAoB;IAElC,kBAAkB,yBAAyB;IAE3C,IAAI,SAAS;IAEb,UAAU,gBAAgB;IAE1B,oBAAoB,0BAA0B;IAE9C,oBAAoB,2BAA2B;IAE/C,yBAAyB,gCAAgC;IAGzD,mBAAmB,yBAAyB;IAI5C,cAAc,oBAAoB;IAElC,eAAe,qBAAqB;IAEpC,iBAAiB,uBAAuB;IAExC,yBAAyB,gCAAgC;IAEzD,WAAW,iBAAiB;IAI5B,UAAU,gBAAgB;IAE1B,YAAY,kBAAkB;IAE9B,cAAc,oBAAoB;IAgBlC,UAAU,eAAe;IAezB,iBAAiB,uBAAuB;IAcxC,YAAY,kBAAkB;CAC/B;AAMD,eAAO,MAAM,sBAAsB,oCAAiC,CAAC;AAErE,MAAM,MAAM,qBAAqB,GAAG,GAAG,gBAAgB,EAAE,CAAC"}
+{"version":3,"file":"contribution-kind.d.ts","sourceRoot":"","sources":["../../../src/contribution/lib/contribution-kind.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAoBxB,oBAAY,gBAAgB;IAE1B,WAAW,iBAAiB;IAC5B,OAAO,aAAa;IACpB,YAAY,kBAAkB;IAC9B,UAAU,gBAAgB;IAC1B,YAAY,kBAAkB;IAC9B,UAAU,gBAAgB;IAC1B,WAAW,iBAAiB;IAC5B,wBAAwB,+BAA+B;IACvD,UAAU,gBAAgB;IAQ1B,YAAY,kBAAkB;IAM9B,WAAW,iBAAiB;IAW5B,cAAc,oBAAoB;IAElC,kBAAkB,yBAAyB;IAE3C,IAAI,SAAS;IAEb,UAAU,gBAAgB;IAE1B,oBAAoB,0BAA0B;IAE9C,oBAAoB,2BAA2B;IAE/C,yBAAyB,gCAAgC;IAGzD,mBAAmB,yBAAyB;IAI5C,cAAc,oBAAoB;IAElC,eAAe,qBAAqB;IAEpC,iBAAiB,uBAAuB;IAExC,yBAAyB,gCAAgC;IAEzD,WAAW,iBAAiB;IAI5B,UAAU,gBAAgB;IAE1B,YAAY,kBAAkB;IAE9B,cAAc,oBAAoB;IAgBlC,UAAU,eAAe;IAezB,iBAAiB,uBAAuB;IAcxC,YAAY,kBAAkB;IAkB9B,UAAU,gBAAgB;CAC3B;AAMD,eAAO,MAAM,sBAAsB,oCAAiC,CAAC;AAErE,MAAM,MAAM,qBAAqB,GAAG,GAAG,gBAAgB,EAAE,CAAC"}

package/dist/contribution/lib/contribution-kind.js

@@ -34,6 +34,7 @@ var ContributionKind;
     ContributionKind["Capability"] = "capability";
     ContributionKind["ResourceOwnership"] = "resource-ownership";
     ContributionKind["StageMachine"] = "stage-machine";
+    ContributionKind["SearchType"] = "search-type";
 })(ContributionKind || (exports.ContributionKind = ContributionKind = {}));
 exports.ContributionKindSchema = zod_1.z.nativeEnum(ContributionKind);
 //# sourceMappingURL=contribution-kind.js.map

package/dist/contribution/lib/contribution-kind.js.map

@@ -1 +1 @@
-{"version":3,"file":"contribution-kind.js","sourceRoot":"","sources":["../../../src/contribution/lib/contribution-kind.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAoBxB,IAAY,gBAoHX;AApHD,WAAY,gBAAgB;IAE1B,gDAA4B,CAAA;IAC5B,wCAAoB,CAAA;IACpB,kDAA8B,CAAA;IAC9B,8CAA0B,CAAA;IAC1B,kDAA8B,CAAA;IAC9B,8CAA0B,CAAA;IAC1B,gDAA4B,CAAA;IAC5B,2EAAuD,CAAA;IACvD,8CAA0B,CAAA;IAQ1B,kDAA8B,CAAA;IAM9B,gDAA4B,CAAA;IAW5B,sDAAkC,CAAA;IAElC,+DAA2C,CAAA;IAE3C,iCAAa,CAAA;IAEb,8CAA0B,CAAA;IAE1B,kEAA8C,CAAA;IAE9C,mEAA+C,CAAA;IAE/C,6EAAyD,CAAA;IAGzD,gEAA4C,CAAA;IAI5C,sDAAkC,CAAA;IAElC,wDAAoC,CAAA;IAEpC,4DAAwC,CAAA;IAExC,6EAAyD,CAAA;IAEzD,gDAA4B,CAAA;IAI5B,8CAA0B,CAAA;IAE1B,kDAA8B,CAAA;IAE9B,sDAAkC,CAAA;IAgBlC,6CAAyB,CAAA;IAezB,4DAAwC,CAAA;IAcxC,kDAA8B,CAAA;AAChC,CAAC,EApHW,gBAAgB,gCAAhB,gBAAgB,QAoH3B;AAMY,QAAA,sBAAsB,GAAG,OAAC,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC"}
+{"version":3,"file":"contribution-kind.js","sourceRoot":"","sources":["../../../src/contribution/lib/contribution-kind.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAoBxB,IAAY,gBAsIX;AAtID,WAAY,gBAAgB;IAE1B,gDAA4B,CAAA;IAC5B,wCAAoB,CAAA;IACpB,kDAA8B,CAAA;IAC9B,8CAA0B,CAAA;IAC1B,kDAA8B,CAAA;IAC9B,8CAA0B,CAAA;IAC1B,gDAA4B,CAAA;IAC5B,2EAAuD,CAAA;IACvD,8CAA0B,CAAA;IAQ1B,kDAA8B,CAAA;IAM9B,gDAA4B,CAAA;IAW5B,sDAAkC,CAAA;IAElC,+DAA2C,CAAA;IAE3C,iCAAa,CAAA;IAEb,8CAA0B,CAAA;IAE1B,kEAA8C,CAAA;IAE9C,mEAA+C,CAAA;IAE/C,6EAAyD,CAAA;IAGzD,gEAA4C,CAAA;IAI5C,sDAAkC,CAAA;IAElC,wDAAoC,CAAA;IAEpC,4DAAwC,CAAA;IAExC,6EAAyD,CAAA;IAEzD,gDAA4B,CAAA;IAI5B,8CAA0B,CAAA;IAE1B,kDAA8B,CAAA;IAE9B,sDAAkC,CAAA;IAgBlC,6CAAyB,CAAA;IAezB,4DAAwC,CAAA;IAcxC,kDAA8B,CAAA;IAkB9B,8CAA0B,CAAA;AAC5B,CAAC,EAtIW,gBAAgB,gCAAhB,gBAAgB,QAsI3B;AAMY,QAAA,sBAAsB,GAAG,OAAC,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC"}

package/dist/search/index.d.ts

@@ -0,0 +1,2 @@
+export * from './lib/search-contribution';
+//# sourceMappingURL=index.d.ts.map

package/dist/search/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/search/index.ts"],"names":[],"mappings":"AAkBA,cAAc,2BAA2B,CAAC"}

package/dist/search/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./lib/search-contribution"), exports);
+//# sourceMappingURL=index.js.map

package/dist/search/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/search/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAkBA,4DAA0C"}

package/dist/search/lib/search-contribution.d.ts

@@ -0,0 +1,27 @@
+import { z } from 'zod';
+import { type CapabilityRef } from '../../capability';
+import { XemaObjectKind } from '../../object';
+import { ResourceVisibilityPattern } from '../../resource';
+export interface SearchTypeRenderHints {
+    readonly label: string;
+    readonly icon?: string;
+    readonly routeTemplate?: string;
+}
+export declare const SearchTypeRenderHintsSchema: z.ZodType<SearchTypeRenderHints>;
+export interface SearchTypeAuthzMapping {
+    readonly resourceType: string;
+    readonly defaultVisibility: ResourceVisibilityPattern;
+}
+export declare const SearchTypeAuthzMappingSchema: z.ZodType<SearchTypeAuthzMapping>;
+export interface SearchTypeContributionManifest {
+    readonly objectKind: XemaObjectKind;
+    readonly docType?: string;
+    readonly renderHints: SearchTypeRenderHints;
+    readonly searchableFields: readonly string[];
+    readonly embeddingEligibleDefault: boolean;
+    readonly authz: SearchTypeAuthzMapping;
+    readonly searchReplayCapabilityRef?: CapabilityRef;
+}
+export declare const SearchTypeContributionManifestSchema: z.ZodType<SearchTypeContributionManifest>;
+export declare function searchTypeNaturalKey(objectKind: XemaObjectKind, docType?: string): string;
+//# sourceMappingURL=search-contribution.d.ts.map

package/dist/search/lib/search-contribution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-contribution.d.ts","sourceRoot":"","sources":["../../../src/search/lib/search-contribution.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAuB,KAAK,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAC3E,OAAO,EAAE,cAAc,EAAwB,MAAM,cAAc,CAAC;AACpE,OAAO,EACL,yBAAyB,EAE1B,MAAM,gBAAgB,CAAC;AA6BxB,MAAM,WAAW,qBAAqB;IAEpC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAMvB,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;CACjC;AAED,eAAO,MAAM,2BAA2B,EAAE,CAAC,CAAC,OAAO,CAAC,qBAAqB,CASjC,CAAC;AAWzC,MAAM,WAAW,sBAAsB;IAErC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B,QAAQ,CAAC,iBAAiB,EAAE,yBAAyB,CAAC;CACvD;AAED,eAAO,MAAM,4BAA4B,EAAE,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAIlC,CAAC;AAiB1C,MAAM,WAAW,8BAA8B;IAK7C,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC;IAMpC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAE1B,QAAQ,CAAC,WAAW,EAAE,qBAAqB,CAAC;IAK5C,QAAQ,CAAC,gBAAgB,EAAE,SAAS,MAAM,EAAE,CAAC;IAM7C,QAAQ,CAAC,wBAAwB,EAAE,OAAO,CAAC;IAE3C,QAAQ,CAAC,KAAK,EAAE,sBAAsB,CAAC;IAOvC,QAAQ,CAAC,yBAAyB,CAAC,EAAE,aAAa,CAAC;CACpD;AASD,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,OAAO,CAAC,8BAA8B,CAY1C,CAAC;AAOlD,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,cAAc,EAC1B,OAAO,CAAC,EAAE,MAAM,GACf,MAAM,CAER"}

package/dist/search/lib/search-contribution.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchTypeContributionManifestSchema = exports.SearchTypeAuthzMappingSchema = exports.SearchTypeRenderHintsSchema = void 0;
+exports.searchTypeNaturalKey = searchTypeNaturalKey;
+const zod_1 = require("zod");
+const capability_1 = require("../../capability");
+const object_1 = require("../../object");
+const resource_1 = require("../../resource");
+const SEARCH_TYPE_STRING_MAX = 200;
+const SEARCH_TYPE_ROUTE_TEMPLATE_MAX = 500;
+const SEARCH_TYPE_FIELDS_MAX = 100;
+exports.SearchTypeRenderHintsSchema = zod_1.z.object({
+    label: zod_1.z.string().min(1).max(SEARCH_TYPE_STRING_MAX),
+    icon: zod_1.z.string().min(1).max(SEARCH_TYPE_STRING_MAX).optional(),
+    routeTemplate: zod_1.z
+        .string()
+        .min(1)
+        .max(SEARCH_TYPE_ROUTE_TEMPLATE_MAX)
+        .optional(),
+});
+exports.SearchTypeAuthzMappingSchema = zod_1.z.object({
+    resourceType: zod_1.z.string().min(1).max(SEARCH_TYPE_STRING_MAX),
+    defaultVisibility: resource_1.ResourceVisibilityPatternSchema,
+});
+exports.SearchTypeContributionManifestSchema = zod_1.z.object({
+    objectKind: object_1.XemaObjectKindSchema,
+    docType: zod_1.z.string().min(1).max(SEARCH_TYPE_STRING_MAX).optional(),
+    renderHints: exports.SearchTypeRenderHintsSchema,
+    searchableFields: zod_1.z
+        .array(zod_1.z.string().min(1).max(SEARCH_TYPE_STRING_MAX))
+        .min(1)
+        .max(SEARCH_TYPE_FIELDS_MAX),
+    embeddingEligibleDefault: zod_1.z.boolean(),
+    authz: exports.SearchTypeAuthzMappingSchema,
+    searchReplayCapabilityRef: capability_1.CapabilityRefSchema.optional(),
+});
+function searchTypeNaturalKey(objectKind, docType) {
+    return docType ? `${objectKind}/${docType}` : String(objectKind);
+}
+//# sourceMappingURL=search-contribution.js.map

package/dist/search/lib/search-contribution.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-contribution.js","sourceRoot":"","sources":["../../../src/search/lib/search-contribution.ts"],"names":[],"mappings":";;;AA+JA,oDAKC;AApKD,6BAAwB;AAExB,iDAA2E;AAC3E,yCAAoE;AACpE,6CAGwB;AAOxB,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAOnC,MAAM,8BAA8B,GAAG,GAAG,CAAC;AAO3C,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAqBtB,QAAA,2BAA2B,GACtC,OAAC,CAAC,MAAM,CAAC;IACP,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,sBAAsB,CAAC;IACpD,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC,QAAQ,EAAE;IAC9D,aAAa,EAAE,OAAC;SACb,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,8BAA8B,CAAC;SACnC,QAAQ,EAAE;CACd,CAAqC,CAAC;AAkB5B,QAAA,4BAA4B,GACvC,OAAC,CAAC,MAAM,CAAC;IACP,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,sBAAsB,CAAC;IAC3D,iBAAiB,EAAE,0CAA+B;CACnD,CAAsC,CAAC;AA4D7B,QAAA,oCAAoC,GAC/C,OAAC,CAAC,MAAM,CAAC;IACP,UAAU,EAAE,6BAAoB;IAChC,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC,QAAQ,EAAE;IACjE,WAAW,EAAE,mCAA2B;IACxC,gBAAgB,EAAE,OAAC;SAChB,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;SACpD,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,sBAAsB,CAAC;IAC9B,wBAAwB,EAAE,OAAC,CAAC,OAAO,EAAE;IACrC,KAAK,EAAE,oCAA4B;IACnC,yBAAyB,EAAE,gCAAmB,CAAC,QAAQ,EAAE;CAC1D,CAA8C,CAAC;AAOlD,SAAgB,oBAAoB,CAClC,UAA0B,EAC1B,OAAgB;IAEhB,OAAO,OAAO,CAAC,CAAC,CAAC,GAAG,UAAU,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;AACnE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xemahq/kernel-contracts",
-  "version": "0.24.0",
+  "version": "0.25.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)",
@@ -19,28 +19,18 @@
     "dist",
     "src"
   ],
-  "scripts": {
-    "clean": "rm -rf dist",
-    "build": "tsc -p tsconfig.json && node scripts/emit-awp-spec.mjs",
-    "format": "prettier --write \"src/**/*.ts\"",
-    "typecheck": "tsc -p tsconfig.json --noEmit",
-    "lint": "eslint .",
-    "check:boundary": "node scripts/check-subpath-dag.mjs",
-    "docs:manifest-reference": "node scripts/generate-biome-manifest-reference.mjs",
-    "test": "node --test \"tests/*.spec.mjs\""
-  },
   "devDependencies": {
-    "@eslint/js": "catalog:",
-    "@types/node": "catalog:",
-    "eslint": "catalog:",
-    "eslint-config-prettier": "catalog:",
+    "@eslint/js": "^9.39.4",
+    "@types/node": "25.2.3",
+    "eslint": "^9.39.4",
+    "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-import": "^2.31.0",
-    "prettier": "catalog:",
-    "typescript": "catalog:",
-    "typescript-eslint": "catalog:"
+    "prettier": "3.6.2",
+    "typescript": "5.9.3",
+    "typescript-eslint": "^8.56.1"
   },
   "dependencies": {
-    "zod": "catalog:"
+    "zod": "^4.3.6"
   },
   "exports": {
     "./*": {
@@ -49,5 +39,15 @@
       "default": "./dist/*/index.js"
     },
     "./package.json": "./package.json"
+  },
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "tsc -p tsconfig.json && node scripts/emit-awp-spec.mjs",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "lint": "eslint .",
+    "check:boundary": "node scripts/check-subpath-dag.mjs",
+    "docs:manifest-reference": "node scripts/generate-biome-manifest-reference.mjs",
+    "test": "node --test \"tests/*.spec.mjs\""
   }
-}
+}

package/src/contribution/lib/contribution-kind.ts

@@ -134,6 +134,24 @@ export enum ContributionKind {
    * stage machine is a host-domain concept, not a kernel one.
    */
   StageMachine = 'stage-machine',
+
+  // -- Search result-type self-registration ----------------------------------
+  /**
+   * A search RESULT-TYPE declaration contributed by a biome — the
+   * `XemaObjectKind`/`docType` it covers, render/route hints (label, icon,
+   * deep-link template), the searchable-field set + embedding-eligibility
+   * default, and the authz mapping (`resourceType` + default
+   * `ResourceVisibilityPattern`). The kernel owns this enum member AND the
+   * manifest schema (`SearchTypeContributionManifestSchema`, exported from
+   * `@xemahq/kernel-contracts/search`), mirroring the `Capability` and
+   * `ResourceOwnership` kinds: a single value-identical wire shape both the
+   * contribution-file parser (`search-type.parser.ts` in `biome-host-api`) and
+   * the owning service (`search-api`) validate fail-fast. Provenance is stamped
+   * by the parser from the discovering biome's manifest — authors do not
+   * declare it inline. RESULT-TYPES are contributed (declarative, boot-time);
+   * document INSTANCES are event-fed (runtime, via `IndexableDocument`).
+   */
+  SearchType = 'search-type',
 }
 
 /**

package/src/search/index.ts

@@ -0,0 +1,19 @@
+// ═══════════════════════════════════════════════════════════════════════════
+// @xemahq/kernel-contracts/search — search RESULT-TYPE contribution contract.
+//
+// Pure types + Zod schemas for the `ContributionKind.SearchType` manifest: the
+// declarative, boot-time registration of a search result-type (the
+// `(XemaObjectKind, docType)` facet) a biome contributes to `search-api`. The
+// object model (`object` subpath) is the identity backbone, the authz mapping
+// reuses the `resource` subpath's `ResourceVisibilityPattern`, and the optional
+// replay ref reuses the `capability` subpath's `CapabilityRef` — this surface
+// therefore declares exactly three cross-subpath edges
+// (`search -> object`, `search -> resource`, `search -> capability`), all
+// acyclic. Zero runtime deps beyond `zod`.
+//
+// NOTE: this is distinct from the `search-source` subpath, which carries the
+// runtime `IndexableDocument` (document INSTANCES, event-fed). RESULT-TYPES are
+// contributed (declarative); INSTANCES are event-fed (runtime).
+// ═══════════════════════════════════════════════════════════════════════════
+
+export * from './lib/search-contribution';

package/src/search/lib/search-contribution.ts

@@ -0,0 +1,165 @@
+import { z } from 'zod';
+
+import { CapabilityRefSchema, type CapabilityRef } from '../../capability';
+import { XemaObjectKind, XemaObjectKindSchema } from '../../object';
+import {
+  ResourceVisibilityPattern,
+  ResourceVisibilityPatternSchema,
+} from '../../resource';
+
+/**
+ * Maximum length of the short identifier / label strings on a search-type
+ * manifest. Bounded so describe/list responses stay small and persisted rows
+ * have a predictable upper size.
+ */
+const SEARCH_TYPE_STRING_MAX = 200;
+
+/**
+ * Maximum length of the deep-link route template. A route template is a small
+ * path pattern (e.g. `/kb/{orgId}/pages/{slug}`), never a full document, so a
+ * generous-but-bounded cap keeps a contribution envelope small.
+ */
+const SEARCH_TYPE_ROUTE_TEMPLATE_MAX = 500;
+
+/**
+ * Hard cap on the number of searchable fields a single result-type may declare.
+ * A result-type that genuinely needs more distinct searchable fields is a
+ * modelling smell — fold the extra text into `content`.
+ */
+const SEARCH_TYPE_FIELDS_MAX = 100;
+
+/**
+ * `SearchTypeRenderHints` — the generic render/route hints a result-type ships
+ * so the frontend can present a hit WITHOUT hardcoding a per-kind switch. The
+ * search-web biome's generic renderer reads these; a new biome becomes
+ * fully-renderable purely by contributing them.
+ */
+export interface SearchTypeRenderHints {
+  /** Human-readable result-type label (e.g. "Knowledge Page"). ≤ 200 chars. */
+  readonly label: string;
+  /** Optional icon slug/name the frontend maps to an icon component. ≤ 200 chars. */
+  readonly icon?: string;
+  /**
+   * Optional deep-link route template with `{placeholder}` segments the
+   * frontend fills from a result's fields (e.g. `/kb/{orgId}/pages/{slug}`).
+   * ≤ 500 chars. Absent ⇒ the result is not directly deep-linkable.
+   */
+  readonly routeTemplate?: string;
+}
+
+export const SearchTypeRenderHintsSchema: z.ZodType<SearchTypeRenderHints> =
+  z.object({
+    label: z.string().min(1).max(SEARCH_TYPE_STRING_MAX),
+    icon: z.string().min(1).max(SEARCH_TYPE_STRING_MAX).optional(),
+    routeTemplate: z
+      .string()
+      .min(1)
+      .max(SEARCH_TYPE_ROUTE_TEMPLATE_MAX)
+      .optional(),
+  }) as z.ZodType<SearchTypeRenderHints>;
+
+/**
+ * `SearchTypeAuthzMapping` — how instances of this result-type map onto the
+ * result-level permission model. `resourceType` is the FGA resource-type slug
+ * used for the `authorization-api` `ListObjects` push-down; `defaultVisibility`
+ * is the fallback `ResourceVisibilityPattern` applied to an instance that does
+ * not carry its own per-instance visibility. Reuses the kernel
+ * `ResourceVisibilityPattern` — the SAME closed set the `ResourceOwnership`
+ * contribution declares — so search and object-registry never drift.
+ */
+export interface SearchTypeAuthzMapping {
+  /** The FGA/authorization resource-type slug for this result-type. ≤ 200 chars. */
+  readonly resourceType: string;
+  /** Fallback visibility for an instance with no explicit per-instance pattern. */
+  readonly defaultVisibility: ResourceVisibilityPattern;
+}
+
+export const SearchTypeAuthzMappingSchema: z.ZodType<SearchTypeAuthzMapping> =
+  z.object({
+    resourceType: z.string().min(1).max(SEARCH_TYPE_STRING_MAX),
+    defaultVisibility: ResourceVisibilityPatternSchema,
+  }) as z.ZodType<SearchTypeAuthzMapping>;
+
+/**
+ * Manifest shape carried by every `ContributionKind.SearchType` envelope.
+ * One contribution = one search RESULT-TYPE (the `(objectKind, docType)`
+ * facet).
+ *
+ * Mirrors `CapabilityContributionManifest` / `ResourceOwnershipContributionManifest`
+ * precisely: a value-identical subset of the wire body the owning service
+ * (`search-api`) accepts, validated fail-fast at biome-discovery time.
+ * Provenance (`biome.id`, `biome.version`) is NOT a field here — the
+ * `SearchTypeParser` stamps it from the discovering biome's `xema-biome.json`.
+ * Authors do not declare provenance inline.
+ *
+ * Validation is fail-fast: a contribution that violates any constraint is
+ * rejected at boot. No silent coercion.
+ */
+export interface SearchTypeContributionManifest {
+  /**
+   * The `XemaObjectKind` this result-type covers. The object model is the
+   * identity/scope backbone — every result addresses through it.
+   */
+  readonly objectKind: XemaObjectKind;
+  /**
+   * Optional biome sub-facet under `objectKind` (e.g. `kb_page` under
+   * `knowledge-page`). Absent ⇒ the result-type covers the kind as a whole.
+   * The natural key of a result-type is `(objectKind, docType)`.
+   */
+  readonly docType?: string;
+  /** Generic render/route hints so the frontend presents hits without a per-kind switch. */
+  readonly renderHints: SearchTypeRenderHints;
+  /**
+   * The set of instance fields that carry retrieval-worthy text for this
+   * result-type. At least one; hard-capped at 100.
+   */
+  readonly searchableFields: readonly string[];
+  /**
+   * Default embedding-eligibility for instances of this result-type when the
+   * instance itself does not declare `embeddingEligible`. A closed, declared
+   * default — never inferred from any other field.
+   */
+  readonly embeddingEligibleDefault: boolean;
+  /** How instances of this result-type map onto the result-level permission model. */
+  readonly authz: SearchTypeAuthzMapping;
+  /**
+   * Optional capability ref for replaying/opening an instance of this
+   * result-type (e.g. `knowledge-base:page.replay@1`). Absent ⇒ this
+   * result-type has no replay capability. A typed `CapabilityRef`, never a
+   * free-form string.
+   */
+  readonly searchReplayCapabilityRef?: CapabilityRef;
+}
+
+/**
+ * Zod validator for `SearchTypeContributionManifest`. The biome-discovery
+ * parser AND `search-api`'s contribution-sync handler BOTH route every
+ * candidate envelope through this schema, so a malformed contribution fails at
+ * the boundary instead of at the wire (mirrors
+ * `CapabilityContributionManifestSchema`).
+ */
+export const SearchTypeContributionManifestSchema: z.ZodType<SearchTypeContributionManifest> =
+  z.object({
+    objectKind: XemaObjectKindSchema,
+    docType: z.string().min(1).max(SEARCH_TYPE_STRING_MAX).optional(),
+    renderHints: SearchTypeRenderHintsSchema,
+    searchableFields: z
+      .array(z.string().min(1).max(SEARCH_TYPE_STRING_MAX))
+      .min(1)
+      .max(SEARCH_TYPE_FIELDS_MAX),
+    embeddingEligibleDefault: z.boolean(),
+    authz: SearchTypeAuthzMappingSchema,
+    searchReplayCapabilityRef: CapabilityRefSchema.optional(),
+  }) as z.ZodType<SearchTypeContributionManifest>;
+
+/**
+ * The stable natural key of a result-type: `objectKind` when no `docType`, else
+ * `objectKind/docType`. Centralized so the parser slug, the DB unique key, and
+ * the reconciler's `seenKeyOf` all agree.
+ */
+export function searchTypeNaturalKey(
+  objectKind: XemaObjectKind,
+  docType?: string,
+): string {
+  return docType ? `${objectKind}/${docType}` : String(objectKind);
+}