@rippling/rippling-sdk 0.2.0-alpha.100

package/core/platform/custom-objects/schema-manager.d.mts

@@ -0,0 +1,203 @@
+import type { RipplingSDK } from "../../../client.mjs";
+import type { CustomObjectCategoryDefinition, CustomObjectCategoryMutationOptions, ProvisionedCustomObjectCategory, ReconciledCustomObjectCategory } from "./category.mjs";
+import type { AnyCustomObjectDefinition, FieldNames, LogicalCategoryName } from "./types.mjs";
+import type { ProvisionCustomObjectOptions, ProvisionCustomObjectsOptions, ProvisionableFieldParams, ProvisionedCustomObject } from "./provisioning.mjs";
+import type { ReconcileCustomObjectDefinitionOptions, ReconcileCustomObjectDefinitionsOptions, ReconciledCustomObject } from "./lifecycle.mjs";
+/**
+ * Typed manager bound to one category definition and one SDK client.
+ *
+ * @typeParam TName - Logical category name carried by the bound definition.
+ */
+export declare class TypedCustomObjectCategoryManager<TName extends LogicalCategoryName = LogicalCategoryName> {
+    private readonly client;
+    private readonly definition;
+    /**
+     * Creates a typed category manager bound to one SDK client and one category definition.
+     *
+     * @param client - SDK client used for category lifecycle operations.
+     * @param definition - Typed category definition to bind to the manager.
+     */
+    constructor(client: RipplingSDK, definition: CustomObjectCategoryDefinition<TName>);
+    /**
+     * Returns the bound typed category definition.
+     *
+     * @returns Bound typed category definition.
+     */
+    getDefinition(): CustomObjectCategoryDefinition<TName>;
+    /**
+     * Builds the low-level create payload for the bound category definition.
+     *
+     * @returns REST category-create payload for the bound definition.
+     */
+    buildCreateParams(): RipplingSDK.ObjectCategories.ObjectCategoryCreateParams;
+    /**
+     * Builds the low-level update payload for the bound category definition.
+     *
+     * @returns REST category-update payload for the bound definition.
+     */
+    buildUpdateParams(): RipplingSDK.ObjectCategories.ObjectCategoryUpdateParams;
+    /**
+     * Provisions the bound category definition through the REST SDK.
+     *
+     * @param options - Provisioning behavior flags for display-metadata updates.
+     * @returns Provisioning result for the bound category definition.
+     */
+    provision(options?: CustomObjectCategoryMutationOptions): Promise<ProvisionedCustomObjectCategory<TName>>;
+    /**
+     * Reconciles the bound category definition against the backend.
+     *
+     * @param options - Reconciliation behavior flags for display-metadata updates.
+     * @returns Reconciliation result for the bound category definition.
+     */
+    reconcile(options?: CustomObjectCategoryMutationOptions): Promise<ReconciledCustomObjectCategory<TName>>;
+    /** Deletes the category that matches the bound typed definition. */
+    delete(): Promise<boolean>;
+}
+/**
+ * Typed manager bound to one custom-object definition and one SDK client.
+ *
+ * @typeParam TDefinition - Object definition bound to the manager.
+ */
+export declare class TypedCustomObjectSchemaManager<TDefinition extends AnyCustomObjectDefinition = AnyCustomObjectDefinition> {
+    private readonly client;
+    private readonly definition;
+    /**
+     * Creates a typed schema manager bound to one SDK client and one object definition.
+     *
+     * @param client - SDK client used for object lifecycle operations.
+     * @param definition - Typed object definition to bind to the manager.
+     */
+    constructor(client: RipplingSDK, definition: TDefinition);
+    /**
+     * Returns the bound typed object definition.
+     *
+     * @returns Bound typed object definition.
+     */
+    getDefinition(): TDefinition;
+    /**
+     * Returns a typed category manager when the bound definition embeds a category definition.
+     *
+     * @returns Typed category manager for the embedded category definition, when present.
+     */
+    category(): TypedCustomObjectCategoryManager<NonNullable<TDefinition['categoryDefinition']>['name']> | undefined;
+    /**
+     * Builds the low-level create payload for the bound object definition using a resolved category id.
+     *
+     * @param categoryIdentifier - Resolved custom-category id or native category id required by the live API.
+     * @returns REST object-create payload for the bound definition.
+     */
+    buildCreateParams(categoryIdentifier: string): RipplingSDK.CustomObjects.CustomObjectCreateParams;
+    /**
+     * Builds the low-level update payload for the bound object definition using a resolved category id.
+     *
+     * @param categoryIdentifier - Resolved custom-category id or native category id required by the live API.
+     * @returns REST object-update payload for the bound definition.
+     */
+    buildUpdateParams(categoryIdentifier: string): RipplingSDK.CustomObjects.CustomObjectUpdateParams;
+    /**
+     * Builds the low-level platform-managed name-field metadata payload for the bound definition.
+     *
+     * @returns Name-field metadata payload for the bound definition, when needed.
+     */
+    buildNameFieldDetails(): RipplingSDK.CustomObjects.Fields.CustomObjectNameFieldDetails | undefined;
+    /**
+     * Builds typed field create/update payloads for one logical field on the bound definition.
+     *
+     * @param fieldName - Logical field name to compile.
+     * @returns Frozen create/update payload pair for the requested field.
+     * @typeParam TFieldName - Logical field name being compiled.
+     */
+    buildFieldParams<TFieldName extends FieldNames<TDefinition>>(fieldName: TFieldName): ProvisionableFieldParams;
+    /**
+     * Provisions the bound object definition through the REST SDK.
+     *
+     * @param options - Provisioning behavior flags for categories, display metadata, and name fields.
+     * @returns Provisioning result for the bound object definition.
+     */
+    provision(options?: ProvisionCustomObjectOptions): Promise<ProvisionedCustomObject<TDefinition>>;
+    /**
+     * Reconciles the bound object definition against the backend.
+     *
+     * @param options - Reconciliation behavior flags for categories, name fields, and deletions.
+     * @returns Reconciliation result for the bound object definition.
+     */
+    reconcile(options?: ReconcileCustomObjectDefinitionOptions): Promise<ReconciledCustomObject<TDefinition>>;
+    /** Deletes the bound object definition by its compiled api name. */
+    delete(): Promise<void>;
+}
+/**
+ * Root schema manager that binds typed category/object definitions to one SDK client.
+ *
+ * Use this when you want a lifecycle-oriented API for categories, object metadata,
+ * field metadata, and typed reconciliation without manually threading the same
+ * `RipplingSDK` client through every helper call.
+ */
+export declare class CustomObjectSchemaManager {
+    private readonly client;
+    /**
+     * Creates a new schema manager bound to one SDK client.
+     *
+     * @param client - SDK client used for all subsequent category and object lifecycle operations.
+     */
+    constructor(client: RipplingSDK);
+    /**
+     * Returns a typed category manager bound to one category definition.
+     *
+     * @param definition - Typed category definition to bind.
+     * @returns Definition-bound category manager.
+     * @typeParam TName - Logical category name carried by the bound definition.
+     */
+    forCategory<TName extends LogicalCategoryName>(definition: CustomObjectCategoryDefinition<TName>): TypedCustomObjectCategoryManager<TName>;
+    /**
+     * Returns a typed schema manager bound to one object definition.
+     *
+     * @param definition - Typed object definition to bind.
+     * @returns Definition-bound schema manager.
+     * @typeParam TDefinition - Object definition bound to the manager.
+     */
+    forObject<TDefinition extends AnyCustomObjectDefinition>(definition: TDefinition): TypedCustomObjectSchemaManager<TDefinition>;
+    /**
+     * Short ergonomic alias for {@link forObject}.
+     *
+     * @param definition - Typed object definition to bind.
+     * @returns Definition-bound schema manager.
+     * @typeParam TDefinition - Object definition bound to the manager.
+     */
+    for<TDefinition extends AnyCustomObjectDefinition>(definition: TDefinition): TypedCustomObjectSchemaManager<TDefinition>;
+    /**
+     * Provisions multiple typed category definitions through the REST SDK.
+     *
+     * @param definitions - Typed category definitions to provision.
+     * @param options - Provisioning behavior flags shared across the batch.
+     * @returns Provisioning results in input order.
+     */
+    provisionCategories(definitions: readonly CustomObjectCategoryDefinition[], options?: CustomObjectCategoryMutationOptions): Promise<readonly ProvisionedCustomObjectCategory[]>;
+    /**
+     * Reconciles multiple typed category definitions against the backend.
+     *
+     * @param definitions - Typed category definitions to reconcile.
+     * @param options - Reconciliation behavior flags shared across the batch.
+     * @returns Reconciliation results in input order.
+     */
+    reconcileCategories(definitions: readonly CustomObjectCategoryDefinition[], options?: CustomObjectCategoryMutationOptions): Promise<readonly ReconciledCustomObjectCategory[]>;
+    /**
+     * Provisions multiple typed object definitions through the REST SDK.
+     *
+     * @param definitions - Typed object definitions to provision.
+     * @param options - Batch provisioning behavior flags.
+     * @returns Provisioning results in input order.
+     */
+    provisionDefinitions(definitions: readonly AnyCustomObjectDefinition[], options?: ProvisionCustomObjectsOptions): Promise<ReadonlyArray<ProvisionedCustomObject>>;
+    /**
+     * Reconciles multiple typed object definitions against the backend.
+     *
+     * @param definitions - Typed object definitions to reconcile.
+     * @param options - Batch reconciliation behavior flags.
+     * @returns Reconciliation results in input order.
+     */
+    reconcileDefinitions(definitions: readonly AnyCustomObjectDefinition[], options?: ReconcileCustomObjectDefinitionsOptions): Promise<readonly ReconciledCustomObject[]>;
+}
+/** Short alias for teams that prefer concise schema-manager names. */
+export declare class COSchemaManager extends CustomObjectSchemaManager {
+}
+//# sourceMappingURL=schema-manager.d.mts.map

package/core/platform/custom-objects/schema-manager.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-manager.d.mts","sourceRoot":"","sources":["../../../src/core/platform/custom-objects/schema-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,4BAAwB;AACnD,OAAO,KAAK,EACV,8BAA8B,EAC9B,mCAAmC,EACnC,+BAA+B,EAC/B,8BAA8B,EAC/B,uBAAmB;AAUpB,OAAO,KAAK,EAAE,yBAAyB,EAAE,UAAU,EAAE,mBAAmB,EAAE,oBAAgB;AAC1F,OAAO,KAAK,EACV,4BAA4B,EAC5B,6BAA6B,EAC7B,wBAAwB,EACxB,uBAAuB,EACxB,2BAAuB;AASxB,OAAO,KAAK,EACV,sCAAsC,EACtC,uCAAuC,EACvC,sBAAsB,EACvB,wBAAoB;AAOrB;;;;GAIG;AACH,qBAAa,gCAAgC,CAAC,KAAK,SAAS,mBAAmB,GAAG,mBAAmB;IACnG,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IACrC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAwC;IAEnE;;;;;OAKG;gBACS,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC;IAKlF;;;;OAIG;IACH,aAAa,IAAI,8BAA8B,CAAC,KAAK,CAAC;IAItD;;;;OAIG;IACH,iBAAiB;IAIjB;;;;OAIG;IACH,iBAAiB;IAIjB;;;;;OAKG;IACH,SAAS,CACP,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,+BAA+B,CAAC,KAAK,CAAC,CAAC;IAIlD;;;;;OAKG;IACH,SAAS,CACP,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC;IAIjD,oEAAoE;IACpE,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;CAG3B;AAED;;;;GAIG;AACH,qBAAa,8BAA8B,CACzC,WAAW,SAAS,yBAAyB,GAAG,yBAAyB;IAEzE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IACrC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAc;IAEzC;;;;;OAKG;gBACS,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW;IAKxD;;;;OAIG;IACH,aAAa,IAAI,WAAW;IAI5B;;;;OAIG;IACH,QAAQ,IACJ,gCAAgC,CAAC,WAAW,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,GACxF,SAAS;IAOb;;;;;OAKG;IACH,iBAAiB,CAAC,kBAAkB,EAAE,MAAM;IAI5C;;;;;OAKG;IACH,iBAAiB,CAAC,kBAAkB,EAAE,MAAM;IAI5C;;;;OAIG;IACH,qBAAqB;IAIrB;;;;;;OAMG;IACH,gBAAgB,CAAC,UAAU,SAAS,UAAU,CAAC,WAAW,CAAC,EACzD,SAAS,EAAE,UAAU,GACpB,wBAAwB;IAI3B;;;;;OAKG;IACH,SAAS,CAAC,OAAO,GAAE,4BAAiC,GAAG,OAAO,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC;IAIpG;;;;;OAKG;IACH,SAAS,CACP,OAAO,GAAE,sCAA2C,GACnD,OAAO,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;IAI/C,oEAAoE;IACpE,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAGxB;AAED;;;;;;GAMG;AACH,qBAAa,yBAAyB;IACpC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IAErC;;;;OAIG;gBACS,MAAM,EAAE,WAAW;IAI/B;;;;;;OAMG;IACH,WAAW,CAAC,KAAK,SAAS,mBAAmB,EAC3C,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,GAChD,gCAAgC,CAAC,KAAK,CAAC;IAI1C;;;;;;OAMG;IACH,SAAS,CAAC,WAAW,SAAS,yBAAyB,EACrD,UAAU,EAAE,WAAW,GACtB,8BAA8B,CAAC,WAAW,CAAC;IAI9C;;;;;;OAMG;IACH,GAAG,CAAC,WAAW,SAAS,yBAAyB,EAC/C,UAAU,EAAE,WAAW,GACtB,8BAA8B,CAAC,WAAW,CAAC;IAI9C;;;;;;OAMG;IACH,mBAAmB,CACjB,WAAW,EAAE,SAAS,8BAA8B,EAAE,EACtD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,SAAS,+BAA+B,EAAE,CAAC;IAItD;;;;;;OAMG;IACH,mBAAmB,CACjB,WAAW,EAAE,SAAS,8BAA8B,EAAE,EACtD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,SAAS,8BAA8B,EAAE,CAAC;IAIrD;;;;;;OAMG;IACH,oBAAoB,CAClB,WAAW,EAAE,SAAS,yBAAyB,EAAE,EACjD,OAAO,GAAE,6BAAkC,GAC1C,OAAO,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;IAIlD;;;;;;OAMG;IACH,oBAAoB,CAClB,WAAW,EAAE,SAAS,yBAAyB,EAAE,EACjD,OAAO,GAAE,uCAA4C,GACpD,OAAO,CAAC,SAAS,sBAAsB,EAAE,CAAC;CAG9C;AAED,sEAAsE;AACtE,qBAAa,eAAgB,SAAQ,yBAAyB;CAAG"}

package/core/platform/custom-objects/schema-manager.d.ts

@@ -0,0 +1,203 @@
+import type { RipplingSDK } from "../../../client.js";
+import type { CustomObjectCategoryDefinition, CustomObjectCategoryMutationOptions, ProvisionedCustomObjectCategory, ReconciledCustomObjectCategory } from "./category.js";
+import type { AnyCustomObjectDefinition, FieldNames, LogicalCategoryName } from "./types.js";
+import type { ProvisionCustomObjectOptions, ProvisionCustomObjectsOptions, ProvisionableFieldParams, ProvisionedCustomObject } from "./provisioning.js";
+import type { ReconcileCustomObjectDefinitionOptions, ReconcileCustomObjectDefinitionsOptions, ReconciledCustomObject } from "./lifecycle.js";
+/**
+ * Typed manager bound to one category definition and one SDK client.
+ *
+ * @typeParam TName - Logical category name carried by the bound definition.
+ */
+export declare class TypedCustomObjectCategoryManager<TName extends LogicalCategoryName = LogicalCategoryName> {
+    private readonly client;
+    private readonly definition;
+    /**
+     * Creates a typed category manager bound to one SDK client and one category definition.
+     *
+     * @param client - SDK client used for category lifecycle operations.
+     * @param definition - Typed category definition to bind to the manager.
+     */
+    constructor(client: RipplingSDK, definition: CustomObjectCategoryDefinition<TName>);
+    /**
+     * Returns the bound typed category definition.
+     *
+     * @returns Bound typed category definition.
+     */
+    getDefinition(): CustomObjectCategoryDefinition<TName>;
+    /**
+     * Builds the low-level create payload for the bound category definition.
+     *
+     * @returns REST category-create payload for the bound definition.
+     */
+    buildCreateParams(): RipplingSDK.ObjectCategories.ObjectCategoryCreateParams;
+    /**
+     * Builds the low-level update payload for the bound category definition.
+     *
+     * @returns REST category-update payload for the bound definition.
+     */
+    buildUpdateParams(): RipplingSDK.ObjectCategories.ObjectCategoryUpdateParams;
+    /**
+     * Provisions the bound category definition through the REST SDK.
+     *
+     * @param options - Provisioning behavior flags for display-metadata updates.
+     * @returns Provisioning result for the bound category definition.
+     */
+    provision(options?: CustomObjectCategoryMutationOptions): Promise<ProvisionedCustomObjectCategory<TName>>;
+    /**
+     * Reconciles the bound category definition against the backend.
+     *
+     * @param options - Reconciliation behavior flags for display-metadata updates.
+     * @returns Reconciliation result for the bound category definition.
+     */
+    reconcile(options?: CustomObjectCategoryMutationOptions): Promise<ReconciledCustomObjectCategory<TName>>;
+    /** Deletes the category that matches the bound typed definition. */
+    delete(): Promise<boolean>;
+}
+/**
+ * Typed manager bound to one custom-object definition and one SDK client.
+ *
+ * @typeParam TDefinition - Object definition bound to the manager.
+ */
+export declare class TypedCustomObjectSchemaManager<TDefinition extends AnyCustomObjectDefinition = AnyCustomObjectDefinition> {
+    private readonly client;
+    private readonly definition;
+    /**
+     * Creates a typed schema manager bound to one SDK client and one object definition.
+     *
+     * @param client - SDK client used for object lifecycle operations.
+     * @param definition - Typed object definition to bind to the manager.
+     */
+    constructor(client: RipplingSDK, definition: TDefinition);
+    /**
+     * Returns the bound typed object definition.
+     *
+     * @returns Bound typed object definition.
+     */
+    getDefinition(): TDefinition;
+    /**
+     * Returns a typed category manager when the bound definition embeds a category definition.
+     *
+     * @returns Typed category manager for the embedded category definition, when present.
+     */
+    category(): TypedCustomObjectCategoryManager<NonNullable<TDefinition['categoryDefinition']>['name']> | undefined;
+    /**
+     * Builds the low-level create payload for the bound object definition using a resolved category id.
+     *
+     * @param categoryIdentifier - Resolved custom-category id or native category id required by the live API.
+     * @returns REST object-create payload for the bound definition.
+     */
+    buildCreateParams(categoryIdentifier: string): RipplingSDK.CustomObjects.CustomObjectCreateParams;
+    /**
+     * Builds the low-level update payload for the bound object definition using a resolved category id.
+     *
+     * @param categoryIdentifier - Resolved custom-category id or native category id required by the live API.
+     * @returns REST object-update payload for the bound definition.
+     */
+    buildUpdateParams(categoryIdentifier: string): RipplingSDK.CustomObjects.CustomObjectUpdateParams;
+    /**
+     * Builds the low-level platform-managed name-field metadata payload for the bound definition.
+     *
+     * @returns Name-field metadata payload for the bound definition, when needed.
+     */
+    buildNameFieldDetails(): RipplingSDK.CustomObjects.Fields.CustomObjectNameFieldDetails | undefined;
+    /**
+     * Builds typed field create/update payloads for one logical field on the bound definition.
+     *
+     * @param fieldName - Logical field name to compile.
+     * @returns Frozen create/update payload pair for the requested field.
+     * @typeParam TFieldName - Logical field name being compiled.
+     */
+    buildFieldParams<TFieldName extends FieldNames<TDefinition>>(fieldName: TFieldName): ProvisionableFieldParams;
+    /**
+     * Provisions the bound object definition through the REST SDK.
+     *
+     * @param options - Provisioning behavior flags for categories, display metadata, and name fields.
+     * @returns Provisioning result for the bound object definition.
+     */
+    provision(options?: ProvisionCustomObjectOptions): Promise<ProvisionedCustomObject<TDefinition>>;
+    /**
+     * Reconciles the bound object definition against the backend.
+     *
+     * @param options - Reconciliation behavior flags for categories, name fields, and deletions.
+     * @returns Reconciliation result for the bound object definition.
+     */
+    reconcile(options?: ReconcileCustomObjectDefinitionOptions): Promise<ReconciledCustomObject<TDefinition>>;
+    /** Deletes the bound object definition by its compiled api name. */
+    delete(): Promise<void>;
+}
+/**
+ * Root schema manager that binds typed category/object definitions to one SDK client.
+ *
+ * Use this when you want a lifecycle-oriented API for categories, object metadata,
+ * field metadata, and typed reconciliation without manually threading the same
+ * `RipplingSDK` client through every helper call.
+ */
+export declare class CustomObjectSchemaManager {
+    private readonly client;
+    /**
+     * Creates a new schema manager bound to one SDK client.
+     *
+     * @param client - SDK client used for all subsequent category and object lifecycle operations.
+     */
+    constructor(client: RipplingSDK);
+    /**
+     * Returns a typed category manager bound to one category definition.
+     *
+     * @param definition - Typed category definition to bind.
+     * @returns Definition-bound category manager.
+     * @typeParam TName - Logical category name carried by the bound definition.
+     */
+    forCategory<TName extends LogicalCategoryName>(definition: CustomObjectCategoryDefinition<TName>): TypedCustomObjectCategoryManager<TName>;
+    /**
+     * Returns a typed schema manager bound to one object definition.
+     *
+     * @param definition - Typed object definition to bind.
+     * @returns Definition-bound schema manager.
+     * @typeParam TDefinition - Object definition bound to the manager.
+     */
+    forObject<TDefinition extends AnyCustomObjectDefinition>(definition: TDefinition): TypedCustomObjectSchemaManager<TDefinition>;
+    /**
+     * Short ergonomic alias for {@link forObject}.
+     *
+     * @param definition - Typed object definition to bind.
+     * @returns Definition-bound schema manager.
+     * @typeParam TDefinition - Object definition bound to the manager.
+     */
+    for<TDefinition extends AnyCustomObjectDefinition>(definition: TDefinition): TypedCustomObjectSchemaManager<TDefinition>;
+    /**
+     * Provisions multiple typed category definitions through the REST SDK.
+     *
+     * @param definitions - Typed category definitions to provision.
+     * @param options - Provisioning behavior flags shared across the batch.
+     * @returns Provisioning results in input order.
+     */
+    provisionCategories(definitions: readonly CustomObjectCategoryDefinition[], options?: CustomObjectCategoryMutationOptions): Promise<readonly ProvisionedCustomObjectCategory[]>;
+    /**
+     * Reconciles multiple typed category definitions against the backend.
+     *
+     * @param definitions - Typed category definitions to reconcile.
+     * @param options - Reconciliation behavior flags shared across the batch.
+     * @returns Reconciliation results in input order.
+     */
+    reconcileCategories(definitions: readonly CustomObjectCategoryDefinition[], options?: CustomObjectCategoryMutationOptions): Promise<readonly ReconciledCustomObjectCategory[]>;
+    /**
+     * Provisions multiple typed object definitions through the REST SDK.
+     *
+     * @param definitions - Typed object definitions to provision.
+     * @param options - Batch provisioning behavior flags.
+     * @returns Provisioning results in input order.
+     */
+    provisionDefinitions(definitions: readonly AnyCustomObjectDefinition[], options?: ProvisionCustomObjectsOptions): Promise<ReadonlyArray<ProvisionedCustomObject>>;
+    /**
+     * Reconciles multiple typed object definitions against the backend.
+     *
+     * @param definitions - Typed object definitions to reconcile.
+     * @param options - Batch reconciliation behavior flags.
+     * @returns Reconciliation results in input order.
+     */
+    reconcileDefinitions(definitions: readonly AnyCustomObjectDefinition[], options?: ReconcileCustomObjectDefinitionsOptions): Promise<readonly ReconciledCustomObject[]>;
+}
+/** Short alias for teams that prefer concise schema-manager names. */
+export declare class COSchemaManager extends CustomObjectSchemaManager {
+}
+//# sourceMappingURL=schema-manager.d.ts.map

package/core/platform/custom-objects/schema-manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-manager.d.ts","sourceRoot":"","sources":["../../../src/core/platform/custom-objects/schema-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,2BAAwB;AACnD,OAAO,KAAK,EACV,8BAA8B,EAC9B,mCAAmC,EACnC,+BAA+B,EAC/B,8BAA8B,EAC/B,sBAAmB;AAUpB,OAAO,KAAK,EAAE,yBAAyB,EAAE,UAAU,EAAE,mBAAmB,EAAE,mBAAgB;AAC1F,OAAO,KAAK,EACV,4BAA4B,EAC5B,6BAA6B,EAC7B,wBAAwB,EACxB,uBAAuB,EACxB,0BAAuB;AASxB,OAAO,KAAK,EACV,sCAAsC,EACtC,uCAAuC,EACvC,sBAAsB,EACvB,uBAAoB;AAOrB;;;;GAIG;AACH,qBAAa,gCAAgC,CAAC,KAAK,SAAS,mBAAmB,GAAG,mBAAmB;IACnG,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IACrC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAwC;IAEnE;;;;;OAKG;gBACS,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC;IAKlF;;;;OAIG;IACH,aAAa,IAAI,8BAA8B,CAAC,KAAK,CAAC;IAItD;;;;OAIG;IACH,iBAAiB;IAIjB;;;;OAIG;IACH,iBAAiB;IAIjB;;;;;OAKG;IACH,SAAS,CACP,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,+BAA+B,CAAC,KAAK,CAAC,CAAC;IAIlD;;;;;OAKG;IACH,SAAS,CACP,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC;IAIjD,oEAAoE;IACpE,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;CAG3B;AAED;;;;GAIG;AACH,qBAAa,8BAA8B,CACzC,WAAW,SAAS,yBAAyB,GAAG,yBAAyB;IAEzE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IACrC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAc;IAEzC;;;;;OAKG;gBACS,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW;IAKxD;;;;OAIG;IACH,aAAa,IAAI,WAAW;IAI5B;;;;OAIG;IACH,QAAQ,IACJ,gCAAgC,CAAC,WAAW,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,GACxF,SAAS;IAOb;;;;;OAKG;IACH,iBAAiB,CAAC,kBAAkB,EAAE,MAAM;IAI5C;;;;;OAKG;IACH,iBAAiB,CAAC,kBAAkB,EAAE,MAAM;IAI5C;;;;OAIG;IACH,qBAAqB;IAIrB;;;;;;OAMG;IACH,gBAAgB,CAAC,UAAU,SAAS,UAAU,CAAC,WAAW,CAAC,EACzD,SAAS,EAAE,UAAU,GACpB,wBAAwB;IAI3B;;;;;OAKG;IACH,SAAS,CAAC,OAAO,GAAE,4BAAiC,GAAG,OAAO,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC;IAIpG;;;;;OAKG;IACH,SAAS,CACP,OAAO,GAAE,sCAA2C,GACnD,OAAO,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;IAI/C,oEAAoE;IACpE,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAGxB;AAED;;;;;;GAMG;AACH,qBAAa,yBAAyB;IACpC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IAErC;;;;OAIG;gBACS,MAAM,EAAE,WAAW;IAI/B;;;;;;OAMG;IACH,WAAW,CAAC,KAAK,SAAS,mBAAmB,EAC3C,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,GAChD,gCAAgC,CAAC,KAAK,CAAC;IAI1C;;;;;;OAMG;IACH,SAAS,CAAC,WAAW,SAAS,yBAAyB,EACrD,UAAU,EAAE,WAAW,GACtB,8BAA8B,CAAC,WAAW,CAAC;IAI9C;;;;;;OAMG;IACH,GAAG,CAAC,WAAW,SAAS,yBAAyB,EAC/C,UAAU,EAAE,WAAW,GACtB,8BAA8B,CAAC,WAAW,CAAC;IAI9C;;;;;;OAMG;IACH,mBAAmB,CACjB,WAAW,EAAE,SAAS,8BAA8B,EAAE,EACtD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,SAAS,+BAA+B,EAAE,CAAC;IAItD;;;;;;OAMG;IACH,mBAAmB,CACjB,WAAW,EAAE,SAAS,8BAA8B,EAAE,EACtD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,SAAS,8BAA8B,EAAE,CAAC;IAIrD;;;;;;OAMG;IACH,oBAAoB,CAClB,WAAW,EAAE,SAAS,yBAAyB,EAAE,EACjD,OAAO,GAAE,6BAAkC,GAC1C,OAAO,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;IAIlD;;;;;;OAMG;IACH,oBAAoB,CAClB,WAAW,EAAE,SAAS,yBAAyB,EAAE,EACjD,OAAO,GAAE,uCAA4C,GACpD,OAAO,CAAC,SAAS,sBAAsB,EAAE,CAAC;CAG9C;AAED,sEAAsE;AACtE,qBAAa,eAAgB,SAAQ,yBAAyB;CAAG"}

package/core/platform/custom-objects/schema-manager.js

@@ -0,0 +1,256 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.COSchemaManager = exports.CustomObjectSchemaManager = exports.TypedCustomObjectSchemaManager = exports.TypedCustomObjectCategoryManager = void 0;
+const category_1 = require("./category.js");
+const provisioning_1 = require("./provisioning.js");
+const lifecycle_1 = require("./lifecycle.js");
+/**
+ * Typed manager bound to one category definition and one SDK client.
+ *
+ * @typeParam TName - Logical category name carried by the bound definition.
+ */
+class TypedCustomObjectCategoryManager {
+    /**
+     * Creates a typed category manager bound to one SDK client and one category definition.
+     *
+     * @param client - SDK client used for category lifecycle operations.
+     * @param definition - Typed category definition to bind to the manager.
+     */
+    constructor(client, definition) {
+        this.client = client;
+        this.definition = definition;
+    }
+    /**
+     * Returns the bound typed category definition.
+     *
+     * @returns Bound typed category definition.
+     */
+    getDefinition() {
+        return this.definition;
+    }
+    /**
+     * Builds the low-level create payload for the bound category definition.
+     *
+     * @returns REST category-create payload for the bound definition.
+     */
+    buildCreateParams() {
+        return (0, category_1.buildObjectCategoryCreateParams)(this.definition);
+    }
+    /**
+     * Builds the low-level update payload for the bound category definition.
+     *
+     * @returns REST category-update payload for the bound definition.
+     */
+    buildUpdateParams() {
+        return (0, category_1.buildObjectCategoryUpdateParams)(this.definition);
+    }
+    /**
+     * Provisions the bound category definition through the REST SDK.
+     *
+     * @param options - Provisioning behavior flags for display-metadata updates.
+     * @returns Provisioning result for the bound category definition.
+     */
+    provision(options = {}) {
+        return (0, category_1.provisionCustomObjectCategoryDefinition)(this.client, this.definition, options);
+    }
+    /**
+     * Reconciles the bound category definition against the backend.
+     *
+     * @param options - Reconciliation behavior flags for display-metadata updates.
+     * @returns Reconciliation result for the bound category definition.
+     */
+    reconcile(options = {}) {
+        return (0, category_1.reconcileCustomObjectCategoryDefinition)(this.client, this.definition, options);
+    }
+    /** Deletes the category that matches the bound typed definition. */
+    delete() {
+        return (0, category_1.deleteCustomObjectCategoryDefinition)(this.client, this.definition);
+    }
+}
+exports.TypedCustomObjectCategoryManager = TypedCustomObjectCategoryManager;
+/**
+ * Typed manager bound to one custom-object definition and one SDK client.
+ *
+ * @typeParam TDefinition - Object definition bound to the manager.
+ */
+class TypedCustomObjectSchemaManager {
+    /**
+     * Creates a typed schema manager bound to one SDK client and one object definition.
+     *
+     * @param client - SDK client used for object lifecycle operations.
+     * @param definition - Typed object definition to bind to the manager.
+     */
+    constructor(client, definition) {
+        this.client = client;
+        this.definition = definition;
+    }
+    /**
+     * Returns the bound typed object definition.
+     *
+     * @returns Bound typed object definition.
+     */
+    getDefinition() {
+        return this.definition;
+    }
+    /**
+     * Returns a typed category manager when the bound definition embeds a category definition.
+     *
+     * @returns Typed category manager for the embedded category definition, when present.
+     */
+    category() {
+        const categoryDefinition = this.definition.categoryDefinition;
+        return categoryDefinition == null ? undefined : (new TypedCustomObjectCategoryManager(this.client, categoryDefinition));
+    }
+    /**
+     * Builds the low-level create payload for the bound object definition using a resolved category id.
+     *
+     * @param categoryIdentifier - Resolved custom-category id or native category id required by the live API.
+     * @returns REST object-create payload for the bound definition.
+     */
+    buildCreateParams(categoryIdentifier) {
+        return (0, provisioning_1.buildCustomObjectCreateParams)(this.definition, categoryIdentifier);
+    }
+    /**
+     * Builds the low-level update payload for the bound object definition using a resolved category id.
+     *
+     * @param categoryIdentifier - Resolved custom-category id or native category id required by the live API.
+     * @returns REST object-update payload for the bound definition.
+     */
+    buildUpdateParams(categoryIdentifier) {
+        return (0, provisioning_1.buildCustomObjectUpdateParams)(this.definition, categoryIdentifier);
+    }
+    /**
+     * Builds the low-level platform-managed name-field metadata payload for the bound definition.
+     *
+     * @returns Name-field metadata payload for the bound definition, when needed.
+     */
+    buildNameFieldDetails() {
+        return (0, provisioning_1.buildCustomObjectNameFieldDetails)(this.definition);
+    }
+    /**
+     * Builds typed field create/update payloads for one logical field on the bound definition.
+     *
+     * @param fieldName - Logical field name to compile.
+     * @returns Frozen create/update payload pair for the requested field.
+     * @typeParam TFieldName - Logical field name being compiled.
+     */
+    buildFieldParams(fieldName) {
+        return (0, provisioning_1.buildProvisionableFieldParams)(this.definition, fieldName);
+    }
+    /**
+     * Provisions the bound object definition through the REST SDK.
+     *
+     * @param options - Provisioning behavior flags for categories, display metadata, and name fields.
+     * @returns Provisioning result for the bound object definition.
+     */
+    provision(options = {}) {
+        return (0, provisioning_1.provisionCustomObjectDefinition)(this.client, this.definition, options);
+    }
+    /**
+     * Reconciles the bound object definition against the backend.
+     *
+     * @param options - Reconciliation behavior flags for categories, name fields, and deletions.
+     * @returns Reconciliation result for the bound object definition.
+     */
+    reconcile(options = {}) {
+        return (0, lifecycle_1.reconcileCustomObjectDefinition)(this.client, this.definition, options);
+    }
+    /** Deletes the bound object definition by its compiled api name. */
+    delete() {
+        return (0, lifecycle_1.deleteCustomObjectDefinition)(this.client, this.definition);
+    }
+}
+exports.TypedCustomObjectSchemaManager = TypedCustomObjectSchemaManager;
+/**
+ * Root schema manager that binds typed category/object definitions to one SDK client.
+ *
+ * Use this when you want a lifecycle-oriented API for categories, object metadata,
+ * field metadata, and typed reconciliation without manually threading the same
+ * `RipplingSDK` client through every helper call.
+ */
+class CustomObjectSchemaManager {
+    /**
+     * Creates a new schema manager bound to one SDK client.
+     *
+     * @param client - SDK client used for all subsequent category and object lifecycle operations.
+     */
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Returns a typed category manager bound to one category definition.
+     *
+     * @param definition - Typed category definition to bind.
+     * @returns Definition-bound category manager.
+     * @typeParam TName - Logical category name carried by the bound definition.
+     */
+    forCategory(definition) {
+        return new TypedCustomObjectCategoryManager(this.client, definition);
+    }
+    /**
+     * Returns a typed schema manager bound to one object definition.
+     *
+     * @param definition - Typed object definition to bind.
+     * @returns Definition-bound schema manager.
+     * @typeParam TDefinition - Object definition bound to the manager.
+     */
+    forObject(definition) {
+        return new TypedCustomObjectSchemaManager(this.client, definition);
+    }
+    /**
+     * Short ergonomic alias for {@link forObject}.
+     *
+     * @param definition - Typed object definition to bind.
+     * @returns Definition-bound schema manager.
+     * @typeParam TDefinition - Object definition bound to the manager.
+     */
+    for(definition) {
+        return this.forObject(definition);
+    }
+    /**
+     * Provisions multiple typed category definitions through the REST SDK.
+     *
+     * @param definitions - Typed category definitions to provision.
+     * @param options - Provisioning behavior flags shared across the batch.
+     * @returns Provisioning results in input order.
+     */
+    provisionCategories(definitions, options = {}) {
+        return (0, category_1.provisionCustomObjectCategoryDefinitions)(this.client, definitions, options);
+    }
+    /**
+     * Reconciles multiple typed category definitions against the backend.
+     *
+     * @param definitions - Typed category definitions to reconcile.
+     * @param options - Reconciliation behavior flags shared across the batch.
+     * @returns Reconciliation results in input order.
+     */
+    reconcileCategories(definitions, options = {}) {
+        return (0, category_1.reconcileCustomObjectCategoryDefinitions)(this.client, definitions, options);
+    }
+    /**
+     * Provisions multiple typed object definitions through the REST SDK.
+     *
+     * @param definitions - Typed object definitions to provision.
+     * @param options - Batch provisioning behavior flags.
+     * @returns Provisioning results in input order.
+     */
+    provisionDefinitions(definitions, options = {}) {
+        return (0, provisioning_1.provisionCustomObjectDefinitions)(this.client, definitions, options);
+    }
+    /**
+     * Reconciles multiple typed object definitions against the backend.
+     *
+     * @param definitions - Typed object definitions to reconcile.
+     * @param options - Batch reconciliation behavior flags.
+     * @returns Reconciliation results in input order.
+     */
+    reconcileDefinitions(definitions, options = {}) {
+        return (0, lifecycle_1.reconcileCustomObjectDefinitions)(this.client, definitions, options);
+    }
+}
+exports.CustomObjectSchemaManager = CustomObjectSchemaManager;
+/** Short alias for teams that prefer concise schema-manager names. */
+class COSchemaManager extends CustomObjectSchemaManager {
+}
+exports.COSchemaManager = COSchemaManager;
+//# sourceMappingURL=schema-manager.js.map