@rippling/rippling-sdk 0.2.0-alpha.85 → 0.2.0-alpha.86

package/core/platform/custom-objects/category.d.mts

@@ -0,0 +1,125 @@
+import type { RipplingSDK } from "../../../client.mjs";
+import type { ObjectCategory, ObjectCategoryCreateParams, ObjectCategoryUpdateParams } from "../../../resources/object-categories.mjs";
+import type { CategoryApiName, LogicalCategoryName } from "./types.mjs";
+/**
+ * Author input accepted by {@link defineCustomObjectCategory}.
+ *
+ * @typeParam TName - Logical category name supplied by the caller.
+ */
+interface CustomObjectCategoryDefinitionInput<TName extends string> {
+    /** Logical unsuffixed snake_case category name. */
+    readonly name: LogicalCategoryName<TName>;
+    /** Human-readable display name applied after creation. */
+    readonly displayName: string;
+    /** Optional category description. */
+    readonly description?: string;
+}
+/** Immutable typed category definition used by provisioning and lifecycle helpers. */
+export interface CustomObjectCategoryDefinition<TName extends LogicalCategoryName = LogicalCategoryName> {
+    /** Logical unsuffixed snake_case category name. */
+    readonly name: TName;
+    /** Compiled wire-level category api name. */
+    readonly apiName: CategoryApiName<TName>;
+    /** Human-readable display name. */
+    readonly displayName: string;
+    /** Optional category description. */
+    readonly description?: string;
+}
+/** Result returned by category provisioning helpers. */
+export interface ProvisionedCustomObjectCategory<TName extends LogicalCategoryName = LogicalCategoryName> {
+    /** Source typed category definition. */
+    readonly definition: CustomObjectCategoryDefinition<TName>;
+    /** Response returned by `client.objectCategories.create(...)`. */
+    readonly createdCategory: ObjectCategory;
+    /** Response returned by `client.objectCategories.update(...)`. */
+    readonly updatedCategory: ObjectCategory;
+}
+/** Lifecycle action emitted by category reconciliation helpers. */
+export type CustomObjectCategoryLifecycleAction = 'created' | 'updated' | 'unchanged';
+/** Result returned by category reconciliation helpers. */
+export interface ReconciledCustomObjectCategory<TName extends LogicalCategoryName = LogicalCategoryName> {
+    /** Source typed category definition. */
+    readonly definition: CustomObjectCategoryDefinition<TName>;
+    /** Whether the remote category was created, updated, or already matched. */
+    readonly action: CustomObjectCategoryLifecycleAction;
+    /** Remote category after reconciliation. */
+    readonly category: ObjectCategory;
+}
+/** Options for category provisioning and reconciliation helpers. */
+export interface CustomObjectCategoryMutationOptions {
+    /** Whether to apply the follow-up display-metadata update. Defaults to `true`. */
+    readonly updateDisplayMetadata?: boolean;
+}
+/**
+ * Creates an immutable typed custom-object category definition.
+ *
+ * @param definition - Logical category metadata to normalize and freeze.
+ * @returns Immutable typed category definition with compiled API name.
+ * @typeParam TName - Logical category name supplied by the caller.
+ */
+export declare function defineCustomObjectCategory<TName extends string>(definition: CustomObjectCategoryDefinitionInput<TName>): Readonly<CustomObjectCategoryDefinition<LogicalCategoryName<TName>>>;
+/**
+ * Builds the low-level create payload for an object category.
+ *
+ * @param definition - Typed category definition to compile.
+ * @returns REST create payload using the logical category name.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+export declare function buildObjectCategoryCreateParams<TName extends LogicalCategoryName>(definition: CustomObjectCategoryDefinition<TName>): ObjectCategoryCreateParams;
+/**
+ * Builds the low-level update payload for an object category.
+ *
+ * @param definition - Typed category definition to compile.
+ * @returns REST update payload using human-facing display metadata.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+export declare function buildObjectCategoryUpdateParams<TName extends LogicalCategoryName>(definition: CustomObjectCategoryDefinition<TName>): ObjectCategoryUpdateParams;
+/**
+ * Creates one typed custom-object category through the REST SDK.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definition - Typed category definition to provision.
+ * @param options - Provisioning behavior flags for display-metadata updates.
+ * @returns Frozen summary of the created and updated backend category DTOs.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+export declare function provisionCustomObjectCategoryDefinition<TName extends LogicalCategoryName>(client: RipplingSDK, definition: CustomObjectCategoryDefinition<TName>, options?: CustomObjectCategoryMutationOptions): Promise<ProvisionedCustomObjectCategory<TName>>;
+/**
+ * Creates multiple typed custom-object categories through the REST SDK.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definitions - Typed category definitions to provision.
+ * @param options - Provisioning behavior flags shared across the batch.
+ * @returns Frozen batch of provisioning results in input order.
+ */
+export declare function provisionCustomObjectCategoryDefinitions(client: RipplingSDK, definitions: readonly CustomObjectCategoryDefinition[], options?: CustomObjectCategoryMutationOptions): Promise<readonly ProvisionedCustomObjectCategory[]>;
+/**
+ * Reconciles one typed category definition against the backend by name.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definition - Typed category definition to reconcile.
+ * @param options - Reconciliation behavior flags for display-metadata updates.
+ * @returns Frozen reconciliation result describing the final backend category state.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+export declare function reconcileCustomObjectCategoryDefinition<TName extends LogicalCategoryName>(client: RipplingSDK, definition: CustomObjectCategoryDefinition<TName>, options?: CustomObjectCategoryMutationOptions): Promise<ReconciledCustomObjectCategory<TName>>;
+/**
+ * Reconciles multiple typed category definitions against the backend by name.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definitions - Typed category definitions to reconcile.
+ * @param options - Reconciliation behavior flags shared across the batch.
+ * @returns Frozen batch of reconciliation results in input order.
+ */
+export declare function reconcileCustomObjectCategoryDefinitions(client: RipplingSDK, definitions: readonly CustomObjectCategoryDefinition[], options?: CustomObjectCategoryMutationOptions): Promise<readonly ReconciledCustomObjectCategory[]>;
+/**
+ * Deletes a category that matches the typed definition's logical or display name.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definition - Typed category definition used to find the category to delete.
+ * @returns Whether a matching category existed and was deleted.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+export declare function deleteCustomObjectCategoryDefinition<TName extends LogicalCategoryName>(client: RipplingSDK, definition: CustomObjectCategoryDefinition<TName>): Promise<boolean>;
+export {};
+//# sourceMappingURL=category.d.mts.map

package/core/platform/custom-objects/category.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"category.d.mts","sourceRoot":"","sources":["../../../src/core/platform/custom-objects/category.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,4BAAwB;AACnD,OAAO,KAAK,EACV,cAAc,EACd,0BAA0B,EAC1B,0BAA0B,EAC3B,iDAA6C;AAC9C,OAAO,KAAK,EAAE,eAAe,EAAE,mBAAmB,EAAE,oBAAgB;AAIpE;;;;GAIG;AACH,UAAU,mCAAmC,CAAC,KAAK,SAAS,MAAM;IAChE,mDAAmD;IACnD,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAC,KAAK,CAAC,CAAC;IAC1C,0DAA0D;IAC1D,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,qCAAqC;IACrC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,sFAAsF;AACtF,MAAM,WAAW,8BAA8B,CAAC,KAAK,SAAS,mBAAmB,GAAG,mBAAmB;IACrG,mDAAmD;IACnD,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,6CAA6C;IAC7C,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;IACzC,mCAAmC;IACnC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,qCAAqC;IACrC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,wDAAwD;AACxD,MAAM,WAAW,+BAA+B,CAAC,KAAK,SAAS,mBAAmB,GAAG,mBAAmB;IACtG,wCAAwC;IACxC,QAAQ,CAAC,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,CAAC;IAC3D,kEAAkE;IAClE,QAAQ,CAAC,eAAe,EAAE,cAAc,CAAC;IACzC,kEAAkE;IAClE,QAAQ,CAAC,eAAe,EAAE,cAAc,CAAC;CAC1C;AAED,mEAAmE;AACnE,MAAM,MAAM,mCAAmC,GAAG,SAAS,GAAG,SAAS,GAAG,WAAW,CAAC;AAEtF,0DAA0D;AAC1D,MAAM,WAAW,8BAA8B,CAAC,KAAK,SAAS,mBAAmB,GAAG,mBAAmB;IACrG,wCAAwC;IACxC,QAAQ,CAAC,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,CAAC;IAC3D,4EAA4E;IAC5E,QAAQ,CAAC,MAAM,EAAE,mCAAmC,CAAC;IACrD,4CAA4C;IAC5C,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC;CACnC;AAED,oEAAoE;AACpE,MAAM,WAAW,mCAAmC;IAClD,kFAAkF;IAClF,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC;CAC1C;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,SAAS,MAAM,EAC7D,UAAU,EAAE,mCAAmC,CAAC,KAAK,CAAC,GACrD,QAAQ,CAAC,8BAA8B,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAQtE;AAED;;;;;;GAMG;AACH,wBAAgB,+BAA+B,CAAC,KAAK,SAAS,mBAAmB,EAC/E,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,GAChD,0BAA0B,CAK5B;AAED;;;;;;GAMG;AACH,wBAAgB,+BAA+B,CAAC,KAAK,SAAS,mBAAmB,EAC/E,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,GAChD,0BAA0B,CAK5B;AA4DD;;;;;;;;GAQG;AACH,wBAAsB,uCAAuC,CAAC,KAAK,SAAS,mBAAmB,EAC7F,MAAM,EAAE,WAAW,EACnB,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,EACjD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,+BAA+B,CAAC,KAAK,CAAC,CAAC,CAQjD;AAED;;;;;;;GAOG;AACH,wBAAsB,wCAAwC,CAC5D,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE,SAAS,8BAA8B,EAAE,EACtD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,SAAS,+BAA+B,EAAE,CAAC,CAMrD;AAED;;;;;;;;GAQG;AACH,wBAAsB,uCAAuC,CAAC,KAAK,SAAS,mBAAmB,EAC7F,MAAM,EAAE,WAAW,EACnB,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,EACjD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC,CAyBhD;AAED;;;;;;;GAOG;AACH,wBAAsB,wCAAwC,CAC5D,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE,SAAS,8BAA8B,EAAE,EACtD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,SAAS,8BAA8B,EAAE,CAAC,CAMpD;AAED;;;;;;;GAOG;AACH,wBAAsB,oCAAoC,CAAC,KAAK,SAAS,mBAAmB,EAC1F,MAAM,EAAE,WAAW,EACnB,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,GAChD,OAAO,CAAC,OAAO,CAAC,CAKlB"}

package/core/platform/custom-objects/category.d.ts

@@ -0,0 +1,125 @@
+import type { RipplingSDK } from "../../../client.js";
+import type { ObjectCategory, ObjectCategoryCreateParams, ObjectCategoryUpdateParams } from "../../../resources/object-categories.js";
+import type { CategoryApiName, LogicalCategoryName } from "./types.js";
+/**
+ * Author input accepted by {@link defineCustomObjectCategory}.
+ *
+ * @typeParam TName - Logical category name supplied by the caller.
+ */
+interface CustomObjectCategoryDefinitionInput<TName extends string> {
+    /** Logical unsuffixed snake_case category name. */
+    readonly name: LogicalCategoryName<TName>;
+    /** Human-readable display name applied after creation. */
+    readonly displayName: string;
+    /** Optional category description. */
+    readonly description?: string;
+}
+/** Immutable typed category definition used by provisioning and lifecycle helpers. */
+export interface CustomObjectCategoryDefinition<TName extends LogicalCategoryName = LogicalCategoryName> {
+    /** Logical unsuffixed snake_case category name. */
+    readonly name: TName;
+    /** Compiled wire-level category api name. */
+    readonly apiName: CategoryApiName<TName>;
+    /** Human-readable display name. */
+    readonly displayName: string;
+    /** Optional category description. */
+    readonly description?: string;
+}
+/** Result returned by category provisioning helpers. */
+export interface ProvisionedCustomObjectCategory<TName extends LogicalCategoryName = LogicalCategoryName> {
+    /** Source typed category definition. */
+    readonly definition: CustomObjectCategoryDefinition<TName>;
+    /** Response returned by `client.objectCategories.create(...)`. */
+    readonly createdCategory: ObjectCategory;
+    /** Response returned by `client.objectCategories.update(...)`. */
+    readonly updatedCategory: ObjectCategory;
+}
+/** Lifecycle action emitted by category reconciliation helpers. */
+export type CustomObjectCategoryLifecycleAction = 'created' | 'updated' | 'unchanged';
+/** Result returned by category reconciliation helpers. */
+export interface ReconciledCustomObjectCategory<TName extends LogicalCategoryName = LogicalCategoryName> {
+    /** Source typed category definition. */
+    readonly definition: CustomObjectCategoryDefinition<TName>;
+    /** Whether the remote category was created, updated, or already matched. */
+    readonly action: CustomObjectCategoryLifecycleAction;
+    /** Remote category after reconciliation. */
+    readonly category: ObjectCategory;
+}
+/** Options for category provisioning and reconciliation helpers. */
+export interface CustomObjectCategoryMutationOptions {
+    /** Whether to apply the follow-up display-metadata update. Defaults to `true`. */
+    readonly updateDisplayMetadata?: boolean;
+}
+/**
+ * Creates an immutable typed custom-object category definition.
+ *
+ * @param definition - Logical category metadata to normalize and freeze.
+ * @returns Immutable typed category definition with compiled API name.
+ * @typeParam TName - Logical category name supplied by the caller.
+ */
+export declare function defineCustomObjectCategory<TName extends string>(definition: CustomObjectCategoryDefinitionInput<TName>): Readonly<CustomObjectCategoryDefinition<LogicalCategoryName<TName>>>;
+/**
+ * Builds the low-level create payload for an object category.
+ *
+ * @param definition - Typed category definition to compile.
+ * @returns REST create payload using the logical category name.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+export declare function buildObjectCategoryCreateParams<TName extends LogicalCategoryName>(definition: CustomObjectCategoryDefinition<TName>): ObjectCategoryCreateParams;
+/**
+ * Builds the low-level update payload for an object category.
+ *
+ * @param definition - Typed category definition to compile.
+ * @returns REST update payload using human-facing display metadata.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+export declare function buildObjectCategoryUpdateParams<TName extends LogicalCategoryName>(definition: CustomObjectCategoryDefinition<TName>): ObjectCategoryUpdateParams;
+/**
+ * Creates one typed custom-object category through the REST SDK.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definition - Typed category definition to provision.
+ * @param options - Provisioning behavior flags for display-metadata updates.
+ * @returns Frozen summary of the created and updated backend category DTOs.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+export declare function provisionCustomObjectCategoryDefinition<TName extends LogicalCategoryName>(client: RipplingSDK, definition: CustomObjectCategoryDefinition<TName>, options?: CustomObjectCategoryMutationOptions): Promise<ProvisionedCustomObjectCategory<TName>>;
+/**
+ * Creates multiple typed custom-object categories through the REST SDK.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definitions - Typed category definitions to provision.
+ * @param options - Provisioning behavior flags shared across the batch.
+ * @returns Frozen batch of provisioning results in input order.
+ */
+export declare function provisionCustomObjectCategoryDefinitions(client: RipplingSDK, definitions: readonly CustomObjectCategoryDefinition[], options?: CustomObjectCategoryMutationOptions): Promise<readonly ProvisionedCustomObjectCategory[]>;
+/**
+ * Reconciles one typed category definition against the backend by name.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definition - Typed category definition to reconcile.
+ * @param options - Reconciliation behavior flags for display-metadata updates.
+ * @returns Frozen reconciliation result describing the final backend category state.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+export declare function reconcileCustomObjectCategoryDefinition<TName extends LogicalCategoryName>(client: RipplingSDK, definition: CustomObjectCategoryDefinition<TName>, options?: CustomObjectCategoryMutationOptions): Promise<ReconciledCustomObjectCategory<TName>>;
+/**
+ * Reconciles multiple typed category definitions against the backend by name.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definitions - Typed category definitions to reconcile.
+ * @param options - Reconciliation behavior flags shared across the batch.
+ * @returns Frozen batch of reconciliation results in input order.
+ */
+export declare function reconcileCustomObjectCategoryDefinitions(client: RipplingSDK, definitions: readonly CustomObjectCategoryDefinition[], options?: CustomObjectCategoryMutationOptions): Promise<readonly ReconciledCustomObjectCategory[]>;
+/**
+ * Deletes a category that matches the typed definition's logical or display name.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definition - Typed category definition used to find the category to delete.
+ * @returns Whether a matching category existed and was deleted.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+export declare function deleteCustomObjectCategoryDefinition<TName extends LogicalCategoryName>(client: RipplingSDK, definition: CustomObjectCategoryDefinition<TName>): Promise<boolean>;
+export {};
+//# sourceMappingURL=category.d.ts.map

package/core/platform/custom-objects/category.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"category.d.ts","sourceRoot":"","sources":["../../../src/core/platform/custom-objects/category.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,2BAAwB;AACnD,OAAO,KAAK,EACV,cAAc,EACd,0BAA0B,EAC1B,0BAA0B,EAC3B,gDAA6C;AAC9C,OAAO,KAAK,EAAE,eAAe,EAAE,mBAAmB,EAAE,mBAAgB;AAIpE;;;;GAIG;AACH,UAAU,mCAAmC,CAAC,KAAK,SAAS,MAAM;IAChE,mDAAmD;IACnD,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAC,KAAK,CAAC,CAAC;IAC1C,0DAA0D;IAC1D,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,qCAAqC;IACrC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,sFAAsF;AACtF,MAAM,WAAW,8BAA8B,CAAC,KAAK,SAAS,mBAAmB,GAAG,mBAAmB;IACrG,mDAAmD;IACnD,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,6CAA6C;IAC7C,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;IACzC,mCAAmC;IACnC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,qCAAqC;IACrC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,wDAAwD;AACxD,MAAM,WAAW,+BAA+B,CAAC,KAAK,SAAS,mBAAmB,GAAG,mBAAmB;IACtG,wCAAwC;IACxC,QAAQ,CAAC,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,CAAC;IAC3D,kEAAkE;IAClE,QAAQ,CAAC,eAAe,EAAE,cAAc,CAAC;IACzC,kEAAkE;IAClE,QAAQ,CAAC,eAAe,EAAE,cAAc,CAAC;CAC1C;AAED,mEAAmE;AACnE,MAAM,MAAM,mCAAmC,GAAG,SAAS,GAAG,SAAS,GAAG,WAAW,CAAC;AAEtF,0DAA0D;AAC1D,MAAM,WAAW,8BAA8B,CAAC,KAAK,SAAS,mBAAmB,GAAG,mBAAmB;IACrG,wCAAwC;IACxC,QAAQ,CAAC,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,CAAC;IAC3D,4EAA4E;IAC5E,QAAQ,CAAC,MAAM,EAAE,mCAAmC,CAAC;IACrD,4CAA4C;IAC5C,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC;CACnC;AAED,oEAAoE;AACpE,MAAM,WAAW,mCAAmC;IAClD,kFAAkF;IAClF,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC;CAC1C;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,SAAS,MAAM,EAC7D,UAAU,EAAE,mCAAmC,CAAC,KAAK,CAAC,GACrD,QAAQ,CAAC,8BAA8B,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAQtE;AAED;;;;;;GAMG;AACH,wBAAgB,+BAA+B,CAAC,KAAK,SAAS,mBAAmB,EAC/E,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,GAChD,0BAA0B,CAK5B;AAED;;;;;;GAMG;AACH,wBAAgB,+BAA+B,CAAC,KAAK,SAAS,mBAAmB,EAC/E,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,GAChD,0BAA0B,CAK5B;AA4DD;;;;;;;;GAQG;AACH,wBAAsB,uCAAuC,CAAC,KAAK,SAAS,mBAAmB,EAC7F,MAAM,EAAE,WAAW,EACnB,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,EACjD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,+BAA+B,CAAC,KAAK,CAAC,CAAC,CAQjD;AAED;;;;;;;GAOG;AACH,wBAAsB,wCAAwC,CAC5D,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE,SAAS,8BAA8B,EAAE,EACtD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,SAAS,+BAA+B,EAAE,CAAC,CAMrD;AAED;;;;;;;;GAQG;AACH,wBAAsB,uCAAuC,CAAC,KAAK,SAAS,mBAAmB,EAC7F,MAAM,EAAE,WAAW,EACnB,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,EACjD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC,CAyBhD;AAED;;;;;;;GAOG;AACH,wBAAsB,wCAAwC,CAC5D,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE,SAAS,8BAA8B,EAAE,EACtD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,SAAS,8BAA8B,EAAE,CAAC,CAMpD;AAED;;;;;;;GAOG;AACH,wBAAsB,oCAAoC,CAAC,KAAK,SAAS,mBAAmB,EAC1F,MAAM,EAAE,WAAW,EACnB,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,GAChD,OAAO,CAAC,OAAO,CAAC,CAKlB"}

package/core/platform/custom-objects/category.js

@@ -0,0 +1,188 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineCustomObjectCategory = defineCustomObjectCategory;
+exports.buildObjectCategoryCreateParams = buildObjectCategoryCreateParams;
+exports.buildObjectCategoryUpdateParams = buildObjectCategoryUpdateParams;
+exports.provisionCustomObjectCategoryDefinition = provisionCustomObjectCategoryDefinition;
+exports.provisionCustomObjectCategoryDefinitions = provisionCustomObjectCategoryDefinitions;
+exports.reconcileCustomObjectCategoryDefinition = reconcileCustomObjectCategoryDefinition;
+exports.reconcileCustomObjectCategoryDefinitions = reconcileCustomObjectCategoryDefinitions;
+exports.deleteCustomObjectCategoryDefinition = deleteCustomObjectCategoryDefinition;
+const definition_1 = require("./definition.js");
+const validation_1 = require("./validation.js");
+/**
+ * Creates an immutable typed custom-object category definition.
+ *
+ * @param definition - Logical category metadata to normalize and freeze.
+ * @returns Immutable typed category definition with compiled API name.
+ * @typeParam TName - Logical category name supplied by the caller.
+ */
+function defineCustomObjectCategory(definition) {
+    (0, validation_1.validateLogicalCategoryName)(definition.name);
+    return Object.freeze({
+        name: definition.name,
+        apiName: (0, definition_1.toCustomCategoryApiName)(definition.name),
+        displayName: definition.displayName,
+        ...(definition.description != null ? { description: definition.description } : {}),
+    });
+}
+/**
+ * Builds the low-level create payload for an object category.
+ *
+ * @param definition - Typed category definition to compile.
+ * @returns REST create payload using the logical category name.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+function buildObjectCategoryCreateParams(definition) {
+    return {
+        name: definition.name,
+        ...(definition.description != null ? { description: definition.description } : {}),
+    };
+}
+/**
+ * Builds the low-level update payload for an object category.
+ *
+ * @param definition - Typed category definition to compile.
+ * @returns REST update payload using human-facing display metadata.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+function buildObjectCategoryUpdateParams(definition) {
+    return {
+        name: definition.displayName,
+        ...(definition.description != null ? { description: definition.description } : {}),
+    };
+}
+/**
+ * Returns whether one public category DTO matches the typed category definition by currently visible names.
+ *
+ * @param category - Public category DTO returned by the REST API.
+ * @param definition - Typed category definition being matched.
+ * @returns Whether the visible name matches either the logical or display name.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+function isMatchingCategoryName(category, definition) {
+    return category.name === definition.name || category.name === definition.displayName;
+}
+/**
+ * Lists all public category DTOs that ambiguously or exactly match one typed definition.
+ *
+ * @param client - SDK client used to enumerate categories.
+ * @param definition - Typed category definition being matched.
+ * @returns Frozen list of public categories whose visible names match.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+async function listMatchingCategories(client, definition) {
+    const matches = [];
+    for await (const category of client.objectCategories.list()) {
+        if (isMatchingCategoryName(category, definition)) {
+            matches.push(category);
+        }
+    }
+    return Object.freeze(matches);
+}
+/**
+ * Returns the single public category matching one typed definition or throws when the match is ambiguous.
+ *
+ * @param client - SDK client used to enumerate categories.
+ * @param definition - Typed category definition being matched.
+ * @returns Matching public category, if any.
+ * @throws Error when multiple public categories match the visible names.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+async function getSingleMatchingCategory(client, definition) {
+    const matches = await listMatchingCategories(client, definition);
+    if (matches.length <= 1)
+        return matches[0];
+    throw new Error(`Ambiguous category match for "${definition.name}" / "${definition.displayName}". ` +
+        `Matched ids: ${matches.map((category) => category.id).join(', ')}.`);
+}
+/**
+ * Creates one typed custom-object category through the REST SDK.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definition - Typed category definition to provision.
+ * @param options - Provisioning behavior flags for display-metadata updates.
+ * @returns Frozen summary of the created and updated backend category DTOs.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+async function provisionCustomObjectCategoryDefinition(client, definition, options = {}) {
+    const createdCategory = await client.objectCategories.create(buildObjectCategoryCreateParams(definition));
+    const updatedCategory = options.updateDisplayMetadata ?? true ?
+        await client.objectCategories.update(createdCategory.id, buildObjectCategoryUpdateParams(definition))
+        : createdCategory;
+    return Object.freeze({ definition, createdCategory, updatedCategory });
+}
+/**
+ * Creates multiple typed custom-object categories through the REST SDK.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definitions - Typed category definitions to provision.
+ * @param options - Provisioning behavior flags shared across the batch.
+ * @returns Frozen batch of provisioning results in input order.
+ */
+async function provisionCustomObjectCategoryDefinitions(client, definitions, options = {}) {
+    const results = [];
+    for (const definition of definitions) {
+        results.push(await provisionCustomObjectCategoryDefinition(client, definition, options));
+    }
+    return Object.freeze(results);
+}
+/**
+ * Reconciles one typed category definition against the backend by name.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definition - Typed category definition to reconcile.
+ * @param options - Reconciliation behavior flags for display-metadata updates.
+ * @returns Frozen reconciliation result describing the final backend category state.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+async function reconcileCustomObjectCategoryDefinition(client, definition, options = {}) {
+    const existing = await getSingleMatchingCategory(client, definition);
+    if (existing == null) {
+        const provisioned = await provisionCustomObjectCategoryDefinition(client, definition, options);
+        return Object.freeze({
+            definition,
+            action: 'created',
+            category: provisioned.updatedCategory,
+        });
+    }
+    const shouldUpdate = (options.updateDisplayMetadata ?? true) &&
+        (existing.name !== definition.displayName ||
+            (existing.description ?? '') !== (definition.description ?? ''));
+    if (!shouldUpdate) {
+        return Object.freeze({ definition, action: 'unchanged', category: existing });
+    }
+    const updated = await client.objectCategories.update(existing.id, buildObjectCategoryUpdateParams(definition));
+    return Object.freeze({ definition, action: 'updated', category: updated });
+}
+/**
+ * Reconciles multiple typed category definitions against the backend by name.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definitions - Typed category definitions to reconcile.
+ * @param options - Reconciliation behavior flags shared across the batch.
+ * @returns Frozen batch of reconciliation results in input order.
+ */
+async function reconcileCustomObjectCategoryDefinitions(client, definitions, options = {}) {
+    const results = [];
+    for (const definition of definitions) {
+        results.push(await reconcileCustomObjectCategoryDefinition(client, definition, options));
+    }
+    return Object.freeze(results);
+}
+/**
+ * Deletes a category that matches the typed definition's logical or display name.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definition - Typed category definition used to find the category to delete.
+ * @returns Whether a matching category existed and was deleted.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+async function deleteCustomObjectCategoryDefinition(client, definition) {
+    const existing = await getSingleMatchingCategory(client, definition);
+    if (existing == null)
+        return false;
+    await client.objectCategories.delete(existing.id);
+    return true;
+}
+//# sourceMappingURL=category.js.map

package/core/platform/custom-objects/category.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"category.js","sourceRoot":"","sources":["../../../src/core/platform/custom-objects/category.ts"],"names":[],"mappings":";;AAwEA,gEAUC;AASD,0EAOC;AASD,0EAOC;AAqED,0FAYC;AAUD,4FAUC;AAWD,0FA6BC;AAUD,4FAUC;AAUD,oFAQC;AA9RD,gDAAuD;AACvD,gDAA2D;AAyD3D;;;;;;GAMG;AACH,SAAgB,0BAA0B,CACxC,UAAsD;IAEtD,IAAA,wCAA2B,EAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC7C,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,IAAI,EAAE,UAAU,CAAC,IAAI;QACrB,OAAO,EAAE,IAAA,oCAAuB,EAAC,UAAU,CAAC,IAAI,CAAC;QACjD,WAAW,EAAE,UAAU,CAAC,WAAW;QACnC,GAAG,CAAC,UAAU,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACnF,CAAyE,CAAC;AAC7E,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,+BAA+B,CAC7C,UAAiD;IAEjD,OAAO;QACL,IAAI,EAAE,UAAU,CAAC,IAAI;QACrB,GAAG,CAAC,UAAU,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACnF,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,+BAA+B,CAC7C,UAAiD;IAEjD,OAAO;QACL,IAAI,EAAE,UAAU,CAAC,WAAW;QAC5B,GAAG,CAAC,UAAU,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACnF,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,sBAAsB,CAC7B,QAAwB,EACxB,UAAiD;IAEjD,OAAO,QAAQ,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,KAAK,UAAU,CAAC,WAAW,CAAC;AACvF,CAAC;AAED;;;;;;;GAOG;AACH,KAAK,UAAU,sBAAsB,CACnC,MAAmB,EACnB,UAAiD;IAEjD,MAAM,OAAO,GAAqB,EAAE,CAAC;IACrC,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,EAAE,CAAC;QAC5D,IAAI,sBAAsB,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,CAAC;YACjD,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;;;GAQG;AACH,KAAK,UAAU,yBAAyB,CACtC,MAAmB,EACnB,UAAiD;IAEjD,MAAM,OAAO,GAAG,MAAM,sBAAsB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACjE,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC;QAAE,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;IAE3C,MAAM,IAAI,KAAK,CACb,iCAAiC,UAAU,CAAC,IAAI,QAAQ,UAAU,CAAC,WAAW,KAAK;QACjF,gBAAgB,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACvE,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,uCAAuC,CAC3D,MAAmB,EACnB,UAAiD,EACjD,UAA+C,EAAE;IAEjD,MAAM,eAAe,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,+BAA+B,CAAC,UAAU,CAAC,CAAC,CAAC;IAC1G,MAAM,eAAe,GACnB,OAAO,CAAC,qBAAqB,IAAI,IAAI,CAAC,CAAC;QACrC,MAAM,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,EAAE,+BAA+B,CAAC,UAAU,CAAC,CAAC;QACvG,CAAC,CAAC,eAAe,CAAC;IAEpB,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,eAAe,EAAE,eAAe,EAAE,CAAC,CAAC;AACzE,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,wCAAwC,CAC5D,MAAmB,EACnB,WAAsD,EACtD,UAA+C,EAAE;IAEjD,MAAM,OAAO,GAAsC,EAAE,CAAC;IACtD,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACrC,OAAO,CAAC,IAAI,CAAC,MAAM,uCAAuC,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;IAC3F,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,uCAAuC,CAC3D,MAAmB,EACnB,UAAiD,EACjD,UAA+C,EAAE;IAEjD,MAAM,QAAQ,GAAG,MAAM,yBAAyB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACrE,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;QACrB,MAAM,WAAW,GAAG,MAAM,uCAAuC,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;QAC/F,OAAO,MAAM,CAAC,MAAM,CAAC;YACnB,UAAU;YACV,MAAM,EAAE,SAAkB;YAC1B,QAAQ,EAAE,WAAW,CAAC,eAAe;SACtC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,YAAY,GAChB,CAAC,OAAO,CAAC,qBAAqB,IAAI,IAAI,CAAC;QACvC,CAAC,QAAQ,CAAC,IAAI,KAAK,UAAU,CAAC,WAAW;YACvC,CAAC,QAAQ,CAAC,WAAW,IAAI,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,CAAC;IAErE,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;IAChF,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAClD,QAAQ,CAAC,EAAE,EACX,+BAA+B,CAAC,UAAU,CAAC,CAC5C,CAAC;IACF,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;AAC7E,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,wCAAwC,CAC5D,MAAmB,EACnB,WAAsD,EACtD,UAA+C,EAAE;IAEjD,MAAM,OAAO,GAAqC,EAAE,CAAC;IACrD,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACrC,OAAO,CAAC,IAAI,CAAC,MAAM,uCAAuC,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;IAC3F,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,oCAAoC,CACxD,MAAmB,EACnB,UAAiD;IAEjD,MAAM,QAAQ,GAAG,MAAM,yBAAyB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACrE,IAAI,QAAQ,IAAI,IAAI;QAAE,OAAO,KAAK,CAAC;IACnC,MAAM,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAClD,OAAO,IAAI,CAAC;AACd,CAAC"}

package/core/platform/custom-objects/category.mjs

@@ -0,0 +1,178 @@
+import { toCustomCategoryApiName } from "./definition.mjs";
+import { validateLogicalCategoryName } from "./validation.mjs";
+/**
+ * Creates an immutable typed custom-object category definition.
+ *
+ * @param definition - Logical category metadata to normalize and freeze.
+ * @returns Immutable typed category definition with compiled API name.
+ * @typeParam TName - Logical category name supplied by the caller.
+ */
+export function defineCustomObjectCategory(definition) {
+    validateLogicalCategoryName(definition.name);
+    return Object.freeze({
+        name: definition.name,
+        apiName: toCustomCategoryApiName(definition.name),
+        displayName: definition.displayName,
+        ...(definition.description != null ? { description: definition.description } : {}),
+    });
+}
+/**
+ * Builds the low-level create payload for an object category.
+ *
+ * @param definition - Typed category definition to compile.
+ * @returns REST create payload using the logical category name.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+export function buildObjectCategoryCreateParams(definition) {
+    return {
+        name: definition.name,
+        ...(definition.description != null ? { description: definition.description } : {}),
+    };
+}
+/**
+ * Builds the low-level update payload for an object category.
+ *
+ * @param definition - Typed category definition to compile.
+ * @returns REST update payload using human-facing display metadata.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+export function buildObjectCategoryUpdateParams(definition) {
+    return {
+        name: definition.displayName,
+        ...(definition.description != null ? { description: definition.description } : {}),
+    };
+}
+/**
+ * Returns whether one public category DTO matches the typed category definition by currently visible names.
+ *
+ * @param category - Public category DTO returned by the REST API.
+ * @param definition - Typed category definition being matched.
+ * @returns Whether the visible name matches either the logical or display name.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+function isMatchingCategoryName(category, definition) {
+    return category.name === definition.name || category.name === definition.displayName;
+}
+/**
+ * Lists all public category DTOs that ambiguously or exactly match one typed definition.
+ *
+ * @param client - SDK client used to enumerate categories.
+ * @param definition - Typed category definition being matched.
+ * @returns Frozen list of public categories whose visible names match.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+async function listMatchingCategories(client, definition) {
+    const matches = [];
+    for await (const category of client.objectCategories.list()) {
+        if (isMatchingCategoryName(category, definition)) {
+            matches.push(category);
+        }
+    }
+    return Object.freeze(matches);
+}
+/**
+ * Returns the single public category matching one typed definition or throws when the match is ambiguous.
+ *
+ * @param client - SDK client used to enumerate categories.
+ * @param definition - Typed category definition being matched.
+ * @returns Matching public category, if any.
+ * @throws Error when multiple public categories match the visible names.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+async function getSingleMatchingCategory(client, definition) {
+    const matches = await listMatchingCategories(client, definition);
+    if (matches.length <= 1)
+        return matches[0];
+    throw new Error(`Ambiguous category match for "${definition.name}" / "${definition.displayName}". ` +
+        `Matched ids: ${matches.map((category) => category.id).join(', ')}.`);
+}
+/**
+ * Creates one typed custom-object category through the REST SDK.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definition - Typed category definition to provision.
+ * @param options - Provisioning behavior flags for display-metadata updates.
+ * @returns Frozen summary of the created and updated backend category DTOs.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+export async function provisionCustomObjectCategoryDefinition(client, definition, options = {}) {
+    const createdCategory = await client.objectCategories.create(buildObjectCategoryCreateParams(definition));
+    const updatedCategory = options.updateDisplayMetadata ?? true ?
+        await client.objectCategories.update(createdCategory.id, buildObjectCategoryUpdateParams(definition))
+        : createdCategory;
+    return Object.freeze({ definition, createdCategory, updatedCategory });
+}
+/**
+ * Creates multiple typed custom-object categories through the REST SDK.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definitions - Typed category definitions to provision.
+ * @param options - Provisioning behavior flags shared across the batch.
+ * @returns Frozen batch of provisioning results in input order.
+ */
+export async function provisionCustomObjectCategoryDefinitions(client, definitions, options = {}) {
+    const results = [];
+    for (const definition of definitions) {
+        results.push(await provisionCustomObjectCategoryDefinition(client, definition, options));
+    }
+    return Object.freeze(results);
+}
+/**
+ * Reconciles one typed category definition against the backend by name.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definition - Typed category definition to reconcile.
+ * @param options - Reconciliation behavior flags for display-metadata updates.
+ * @returns Frozen reconciliation result describing the final backend category state.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+export async function reconcileCustomObjectCategoryDefinition(client, definition, options = {}) {
+    const existing = await getSingleMatchingCategory(client, definition);
+    if (existing == null) {
+        const provisioned = await provisionCustomObjectCategoryDefinition(client, definition, options);
+        return Object.freeze({
+            definition,
+            action: 'created',
+            category: provisioned.updatedCategory,
+        });
+    }
+    const shouldUpdate = (options.updateDisplayMetadata ?? true) &&
+        (existing.name !== definition.displayName ||
+            (existing.description ?? '') !== (definition.description ?? ''));
+    if (!shouldUpdate) {
+        return Object.freeze({ definition, action: 'unchanged', category: existing });
+    }
+    const updated = await client.objectCategories.update(existing.id, buildObjectCategoryUpdateParams(definition));
+    return Object.freeze({ definition, action: 'updated', category: updated });
+}
+/**
+ * Reconciles multiple typed category definitions against the backend by name.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definitions - Typed category definitions to reconcile.
+ * @param options - Reconciliation behavior flags shared across the batch.
+ * @returns Frozen batch of reconciliation results in input order.
+ */
+export async function reconcileCustomObjectCategoryDefinitions(client, definitions, options = {}) {
+    const results = [];
+    for (const definition of definitions) {
+        results.push(await reconcileCustomObjectCategoryDefinition(client, definition, options));
+    }
+    return Object.freeze(results);
+}
+/**
+ * Deletes a category that matches the typed definition's logical or display name.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definition - Typed category definition used to find the category to delete.
+ * @returns Whether a matching category existed and was deleted.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+export async function deleteCustomObjectCategoryDefinition(client, definition) {
+    const existing = await getSingleMatchingCategory(client, definition);
+    if (existing == null)
+        return false;
+    await client.objectCategories.delete(existing.id);
+    return true;
+}
+//# sourceMappingURL=category.mjs.map

package/core/platform/custom-objects/category.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"category.mjs","sourceRoot":"","sources":["../../../src/core/platform/custom-objects/category.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,uBAAuB,EAAE,yBAAqB;AACvD,OAAO,EAAE,2BAA2B,EAAE,yBAAqB;AAyD3D;;;;;;GAMG;AACH,MAAM,UAAU,0BAA0B,CACxC,UAAsD;IAEtD,2BAA2B,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC7C,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,IAAI,EAAE,UAAU,CAAC,IAAI;QACrB,OAAO,EAAE,uBAAuB,CAAC,UAAU,CAAC,IAAI,CAAC;QACjD,WAAW,EAAE,UAAU,CAAC,WAAW;QACnC,GAAG,CAAC,UAAU,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACnF,CAAyE,CAAC;AAC7E,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,+BAA+B,CAC7C,UAAiD;IAEjD,OAAO;QACL,IAAI,EAAE,UAAU,CAAC,IAAI;QACrB,GAAG,CAAC,UAAU,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACnF,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,+BAA+B,CAC7C,UAAiD;IAEjD,OAAO;QACL,IAAI,EAAE,UAAU,CAAC,WAAW;QAC5B,GAAG,CAAC,UAAU,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACnF,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,sBAAsB,CAC7B,QAAwB,EACxB,UAAiD;IAEjD,OAAO,QAAQ,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,KAAK,UAAU,CAAC,WAAW,CAAC;AACvF,CAAC;AAED;;;;;;;GAOG;AACH,KAAK,UAAU,sBAAsB,CACnC,MAAmB,EACnB,UAAiD;IAEjD,MAAM,OAAO,GAAqB,EAAE,CAAC;IACrC,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,EAAE,CAAC;QAC5D,IAAI,sBAAsB,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,CAAC;YACjD,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;;;GAQG;AACH,KAAK,UAAU,yBAAyB,CACtC,MAAmB,EACnB,UAAiD;IAEjD,MAAM,OAAO,GAAG,MAAM,sBAAsB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACjE,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC;QAAE,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;IAE3C,MAAM,IAAI,KAAK,CACb,iCAAiC,UAAU,CAAC,IAAI,QAAQ,UAAU,CAAC,WAAW,KAAK;QACjF,gBAAgB,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACvE,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,uCAAuC,CAC3D,MAAmB,EACnB,UAAiD,EACjD,UAA+C,EAAE;IAEjD,MAAM,eAAe,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,+BAA+B,CAAC,UAAU,CAAC,CAAC,CAAC;IAC1G,MAAM,eAAe,GACnB,OAAO,CAAC,qBAAqB,IAAI,IAAI,CAAC,CAAC;QACrC,MAAM,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,EAAE,+BAA+B,CAAC,UAAU,CAAC,CAAC;QACvG,CAAC,CAAC,eAAe,CAAC;IAEpB,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,eAAe,EAAE,eAAe,EAAE,CAAC,CAAC;AACzE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,wCAAwC,CAC5D,MAAmB,EACnB,WAAsD,EACtD,UAA+C,EAAE;IAEjD,MAAM,OAAO,GAAsC,EAAE,CAAC;IACtD,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACrC,OAAO,CAAC,IAAI,CAAC,MAAM,uCAAuC,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;IAC3F,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,uCAAuC,CAC3D,MAAmB,EACnB,UAAiD,EACjD,UAA+C,EAAE;IAEjD,MAAM,QAAQ,GAAG,MAAM,yBAAyB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACrE,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;QACrB,MAAM,WAAW,GAAG,MAAM,uCAAuC,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;QAC/F,OAAO,MAAM,CAAC,MAAM,CAAC;YACnB,UAAU;YACV,MAAM,EAAE,SAAkB;YAC1B,QAAQ,EAAE,WAAW,CAAC,eAAe;SACtC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,YAAY,GAChB,CAAC,OAAO,CAAC,qBAAqB,IAAI,IAAI,CAAC;QACvC,CAAC,QAAQ,CAAC,IAAI,KAAK,UAAU,CAAC,WAAW;YACvC,CAAC,QAAQ,CAAC,WAAW,IAAI,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,CAAC;IAErE,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;IAChF,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAClD,QAAQ,CAAC,EAAE,EACX,+BAA+B,CAAC,UAAU,CAAC,CAC5C,CAAC;IACF,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;AAC7E,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,wCAAwC,CAC5D,MAAmB,EACnB,WAAsD,EACtD,UAA+C,EAAE;IAEjD,MAAM,OAAO,GAAqC,EAAE,CAAC;IACrD,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACrC,OAAO,CAAC,IAAI,CAAC,MAAM,uCAAuC,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;IAC3F,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,oCAAoC,CACxD,MAAmB,EACnB,UAAiD;IAEjD,MAAM,QAAQ,GAAG,MAAM,yBAAyB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACrE,IAAI,QAAQ,IAAI,IAAI;QAAE,OAAO,KAAK,CAAC;IACnC,MAAM,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAClD,OAAO,IAAI,CAAC;AACd,CAAC"}