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

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

@@ -1,97 +0,0 @@
-import type { AnyCustomObjectDefinition, CreateInput, FieldNames, LogicalCategoryName, LogicalCustomFieldName, LogicalCustomObjectName, RecordShape, UpdateInput } from "./types.mjs";
-/** Single validation failure returned by schema or record validators. */
-export interface ValidationIssue {
-    readonly path: string;
-    readonly message: string;
-}
-/** Aggregate validation result returned by runtime validation helpers. */
-export interface ValidationResult {
-    readonly valid: boolean;
-    readonly issues: readonly ValidationIssue[];
-}
-/**
- * Throws when a logical custom-object name is invalid.
- *
- * @param value - Candidate logical custom-object name to validate.
- * @typeParam TObjectName - Candidate logical custom-object name.
- */
-export declare function validateLogicalCustomObjectName<TObjectName extends string>(value: LogicalCustomObjectName<TObjectName> | string): asserts value is LogicalCustomObjectName<TObjectName>;
-/**
- * Throws when a logical category name is invalid.
- *
- * @param value - Candidate logical category name to validate.
- * @typeParam TCategoryName - Candidate logical category name.
- */
-export declare function validateLogicalCategoryName<TCategoryName extends string>(value: LogicalCategoryName<TCategoryName> | string): asserts value is LogicalCategoryName<TCategoryName>;
-/**
- * Throws when a logical custom-field name is invalid.
- *
- * @param value - Candidate logical custom-field name to validate.
- * @typeParam TFieldName - Candidate logical custom-field name.
- */
-export declare function validateLogicalCustomFieldName<TFieldName extends string>(value: LogicalCustomFieldName<TFieldName> | string): asserts value is LogicalCustomFieldName<TFieldName>;
-/**
- * Validates a schema definition after the type system has done its part.
- *
- * @param definition - Typed object definition to validate at runtime.
- * @returns Validation issues describing any remaining runtime-level problems.
- */
-export declare function validateCustomObjectDefinition(definition: AnyCustomObjectDefinition): ValidationIssue[];
-/**
- * Runtime validator for create payloads derived from a schema definition.
- *
- * @param definition - Object definition whose create payload is being validated.
- * @param input - Candidate create payload expressed with logical field names.
- * @returns Aggregate validation result for the supplied create payload.
- * @typeParam TDefinition - Object definition whose create payload is being validated.
- */
-export declare function validateCreateInput<TDefinition extends AnyCustomObjectDefinition>(definition: TDefinition, input: Record<string, unknown>): ValidationResult;
-/**
- * Runtime validator for update payloads derived from a schema definition.
- *
- * @param definition - Object definition whose update payload is being validated.
- * @param input - Candidate update payload expressed with logical field names.
- * @returns Aggregate validation result for the supplied update payload.
- * @typeParam TDefinition - Object definition whose update payload is being validated.
- */
-export declare function validateUpdateInput<TDefinition extends AnyCustomObjectDefinition>(definition: TDefinition, input: Record<string, unknown>): ValidationResult;
-/**
- * Throws a detailed error when a create payload is invalid.
- *
- * @param definition - Object definition whose create payload is being asserted.
- * @param input - Candidate create payload expressed with logical field names.
- * @typeParam TDefinition - Object definition whose create payload is being asserted.
- */
-export declare function assertValidCreateInput<TDefinition extends AnyCustomObjectDefinition>(definition: TDefinition, input: Record<string, unknown>): asserts input is CreateInput<TDefinition>;
-/**
- * Throws a detailed error when an update payload is invalid.
- *
- * @param definition - Object definition whose update payload is being asserted.
- * @param input - Candidate update payload expressed with logical field names.
- * @typeParam TDefinition - Object definition whose update payload is being asserted.
- */
-export declare function assertValidUpdateInput<TDefinition extends AnyCustomObjectDefinition>(definition: TDefinition, input: Record<string, unknown>): asserts input is UpdateInput<TDefinition>;
-/**
- * Casts a generic record object into the strongly typed shape derived from the
- * schema.
- *
- * This helper does not perform runtime validation by itself; pair it with a
- * schema-aware check when the source data is not trusted.
- *
- * @param _definition - Object definition whose record shape should be applied.
- * @param record - Generic record object to cast into the typed record shape.
- * @returns Record cast to the schema-derived typed record shape.
- * @typeParam TDefinition - Object definition whose record shape should be applied.
- */
-export declare function asTypedRecord<TDefinition extends AnyCustomObjectDefinition>(_definition: TDefinition, record: Record<string, unknown>): RecordShape<TDefinition>;
-/**
- * Convenience helper for pulling a known field value out of a typed record.
- *
- * @param record - Typed record to read from.
- * @param fieldName - Logical field name to read.
- * @returns Typed value stored at the requested field name.
- * @typeParam TDefinition - Object definition that produced the record shape.
- * @typeParam TFieldName - Logical field name being read from the record.
- */
-export declare function getRecordValue<TDefinition extends AnyCustomObjectDefinition, TFieldName extends FieldNames<TDefinition>>(record: RecordShape<TDefinition>, fieldName: TFieldName): RecordShape<TDefinition>[TFieldName];
-//# sourceMappingURL=validation.d.mts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"validation.d.mts","sourceRoot":"","sources":["../../../src/core/platform/custom-objects/validation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,yBAAyB,EAEzB,WAAW,EACX,UAAU,EAEV,mBAAmB,EACnB,sBAAsB,EACtB,uBAAuB,EACvB,WAAW,EACX,WAAW,EACZ,oBAAgB;AAEjB,yEAAyE;AACzE,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED,0EAA0E;AAC1E,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,SAAS,eAAe,EAAE,CAAC;CAC7C;AA+GD;;;;;GAKG;AACH,wBAAgB,+BAA+B,CAAC,WAAW,SAAS,MAAM,EACxE,KAAK,EAAE,uBAAuB,CAAC,WAAW,CAAC,GAAG,MAAM,GACnD,OAAO,CAAC,KAAK,IAAI,uBAAuB,CAAC,WAAW,CAAC,CAIvD;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,aAAa,SAAS,MAAM,EACtE,KAAK,EAAE,mBAAmB,CAAC,aAAa,CAAC,GAAG,MAAM,GACjD,OAAO,CAAC,KAAK,IAAI,mBAAmB,CAAC,aAAa,CAAC,CAIrD;AAED;;;;;GAKG;AACH,wBAAgB,8BAA8B,CAAC,UAAU,SAAS,MAAM,EACtE,KAAK,EAAE,sBAAsB,CAAC,UAAU,CAAC,GAAG,MAAM,GACjD,OAAO,CAAC,KAAK,IAAI,sBAAsB,CAAC,UAAU,CAAC,CAIrD;AAgJD;;;;;GAKG;AACH,wBAAgB,8BAA8B,CAAC,UAAU,EAAE,yBAAyB,GAAG,eAAe,EAAE,CA+EvG;AAwED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,SAAS,yBAAyB,EAC/E,UAAU,EAAE,WAAW,EACvB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,gBAAgB,CAGlB;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,SAAS,yBAAyB,EAC/E,UAAU,EAAE,WAAW,EACvB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,gBAAgB,CAGlB;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,WAAW,SAAS,yBAAyB,EAClF,UAAU,EAAE,WAAW,EACvB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,OAAO,CAAC,KAAK,IAAI,WAAW,CAAC,WAAW,CAAC,CAI3C;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,WAAW,SAAS,yBAAyB,EAClF,UAAU,EAAE,WAAW,EACvB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,OAAO,CAAC,KAAK,IAAI,WAAW,CAAC,WAAW,CAAC,CAI3C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAAC,WAAW,SAAS,yBAAyB,EACzE,WAAW,EAAE,WAAW,EACxB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC9B,WAAW,CAAC,WAAW,CAAC,CAE1B;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAC5B,WAAW,SAAS,yBAAyB,EAC7C,UAAU,SAAS,UAAU,CAAC,WAAW,CAAC,EAC1C,MAAM,EAAE,WAAW,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,UAAU,GAAG,WAAW,CAAC,WAAW,CAAC,CAAC,UAAU,CAAC,CAE/F"}

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

@@ -1,97 +0,0 @@
-import type { AnyCustomObjectDefinition, CreateInput, FieldNames, LogicalCategoryName, LogicalCustomFieldName, LogicalCustomObjectName, RecordShape, UpdateInput } from "./types.js";
-/** Single validation failure returned by schema or record validators. */
-export interface ValidationIssue {
-    readonly path: string;
-    readonly message: string;
-}
-/** Aggregate validation result returned by runtime validation helpers. */
-export interface ValidationResult {
-    readonly valid: boolean;
-    readonly issues: readonly ValidationIssue[];
-}
-/**
- * Throws when a logical custom-object name is invalid.
- *
- * @param value - Candidate logical custom-object name to validate.
- * @typeParam TObjectName - Candidate logical custom-object name.
- */
-export declare function validateLogicalCustomObjectName<TObjectName extends string>(value: LogicalCustomObjectName<TObjectName> | string): asserts value is LogicalCustomObjectName<TObjectName>;
-/**
- * Throws when a logical category name is invalid.
- *
- * @param value - Candidate logical category name to validate.
- * @typeParam TCategoryName - Candidate logical category name.
- */
-export declare function validateLogicalCategoryName<TCategoryName extends string>(value: LogicalCategoryName<TCategoryName> | string): asserts value is LogicalCategoryName<TCategoryName>;
-/**
- * Throws when a logical custom-field name is invalid.
- *
- * @param value - Candidate logical custom-field name to validate.
- * @typeParam TFieldName - Candidate logical custom-field name.
- */
-export declare function validateLogicalCustomFieldName<TFieldName extends string>(value: LogicalCustomFieldName<TFieldName> | string): asserts value is LogicalCustomFieldName<TFieldName>;
-/**
- * Validates a schema definition after the type system has done its part.
- *
- * @param definition - Typed object definition to validate at runtime.
- * @returns Validation issues describing any remaining runtime-level problems.
- */
-export declare function validateCustomObjectDefinition(definition: AnyCustomObjectDefinition): ValidationIssue[];
-/**
- * Runtime validator for create payloads derived from a schema definition.
- *
- * @param definition - Object definition whose create payload is being validated.
- * @param input - Candidate create payload expressed with logical field names.
- * @returns Aggregate validation result for the supplied create payload.
- * @typeParam TDefinition - Object definition whose create payload is being validated.
- */
-export declare function validateCreateInput<TDefinition extends AnyCustomObjectDefinition>(definition: TDefinition, input: Record<string, unknown>): ValidationResult;
-/**
- * Runtime validator for update payloads derived from a schema definition.
- *
- * @param definition - Object definition whose update payload is being validated.
- * @param input - Candidate update payload expressed with logical field names.
- * @returns Aggregate validation result for the supplied update payload.
- * @typeParam TDefinition - Object definition whose update payload is being validated.
- */
-export declare function validateUpdateInput<TDefinition extends AnyCustomObjectDefinition>(definition: TDefinition, input: Record<string, unknown>): ValidationResult;
-/**
- * Throws a detailed error when a create payload is invalid.
- *
- * @param definition - Object definition whose create payload is being asserted.
- * @param input - Candidate create payload expressed with logical field names.
- * @typeParam TDefinition - Object definition whose create payload is being asserted.
- */
-export declare function assertValidCreateInput<TDefinition extends AnyCustomObjectDefinition>(definition: TDefinition, input: Record<string, unknown>): asserts input is CreateInput<TDefinition>;
-/**
- * Throws a detailed error when an update payload is invalid.
- *
- * @param definition - Object definition whose update payload is being asserted.
- * @param input - Candidate update payload expressed with logical field names.
- * @typeParam TDefinition - Object definition whose update payload is being asserted.
- */
-export declare function assertValidUpdateInput<TDefinition extends AnyCustomObjectDefinition>(definition: TDefinition, input: Record<string, unknown>): asserts input is UpdateInput<TDefinition>;
-/**
- * Casts a generic record object into the strongly typed shape derived from the
- * schema.
- *
- * This helper does not perform runtime validation by itself; pair it with a
- * schema-aware check when the source data is not trusted.
- *
- * @param _definition - Object definition whose record shape should be applied.
- * @param record - Generic record object to cast into the typed record shape.
- * @returns Record cast to the schema-derived typed record shape.
- * @typeParam TDefinition - Object definition whose record shape should be applied.
- */
-export declare function asTypedRecord<TDefinition extends AnyCustomObjectDefinition>(_definition: TDefinition, record: Record<string, unknown>): RecordShape<TDefinition>;
-/**
- * Convenience helper for pulling a known field value out of a typed record.
- *
- * @param record - Typed record to read from.
- * @param fieldName - Logical field name to read.
- * @returns Typed value stored at the requested field name.
- * @typeParam TDefinition - Object definition that produced the record shape.
- * @typeParam TFieldName - Logical field name being read from the record.
- */
-export declare function getRecordValue<TDefinition extends AnyCustomObjectDefinition, TFieldName extends FieldNames<TDefinition>>(record: RecordShape<TDefinition>, fieldName: TFieldName): RecordShape<TDefinition>[TFieldName];
-//# sourceMappingURL=validation.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../../src/core/platform/custom-objects/validation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,yBAAyB,EAEzB,WAAW,EACX,UAAU,EAEV,mBAAmB,EACnB,sBAAsB,EACtB,uBAAuB,EACvB,WAAW,EACX,WAAW,EACZ,mBAAgB;AAEjB,yEAAyE;AACzE,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED,0EAA0E;AAC1E,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,SAAS,eAAe,EAAE,CAAC;CAC7C;AA+GD;;;;;GAKG;AACH,wBAAgB,+BAA+B,CAAC,WAAW,SAAS,MAAM,EACxE,KAAK,EAAE,uBAAuB,CAAC,WAAW,CAAC,GAAG,MAAM,GACnD,OAAO,CAAC,KAAK,IAAI,uBAAuB,CAAC,WAAW,CAAC,CAIvD;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,aAAa,SAAS,MAAM,EACtE,KAAK,EAAE,mBAAmB,CAAC,aAAa,CAAC,GAAG,MAAM,GACjD,OAAO,CAAC,KAAK,IAAI,mBAAmB,CAAC,aAAa,CAAC,CAIrD;AAED;;;;;GAKG;AACH,wBAAgB,8BAA8B,CAAC,UAAU,SAAS,MAAM,EACtE,KAAK,EAAE,sBAAsB,CAAC,UAAU,CAAC,GAAG,MAAM,GACjD,OAAO,CAAC,KAAK,IAAI,sBAAsB,CAAC,UAAU,CAAC,CAIrD;AAgJD;;;;;GAKG;AACH,wBAAgB,8BAA8B,CAAC,UAAU,EAAE,yBAAyB,GAAG,eAAe,EAAE,CA+EvG;AAwED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,SAAS,yBAAyB,EAC/E,UAAU,EAAE,WAAW,EACvB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,gBAAgB,CAGlB;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,SAAS,yBAAyB,EAC/E,UAAU,EAAE,WAAW,EACvB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,gBAAgB,CAGlB;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,WAAW,SAAS,yBAAyB,EAClF,UAAU,EAAE,WAAW,EACvB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,OAAO,CAAC,KAAK,IAAI,WAAW,CAAC,WAAW,CAAC,CAI3C;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,WAAW,SAAS,yBAAyB,EAClF,UAAU,EAAE,WAAW,EACvB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,OAAO,CAAC,KAAK,IAAI,WAAW,CAAC,WAAW,CAAC,CAI3C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAAC,WAAW,SAAS,yBAAyB,EACzE,WAAW,EAAE,WAAW,EACxB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC9B,WAAW,CAAC,WAAW,CAAC,CAE1B;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAC5B,WAAW,SAAS,yBAAyB,EAC7C,UAAU,SAAS,UAAU,CAAC,WAAW,CAAC,EAC1C,MAAM,EAAE,WAAW,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,UAAU,GAAG,WAAW,CAAC,WAAW,CAAC,CAAC,UAAU,CAAC,CAE/F"}