@party-stack/ontology 0.20.0 → 0.21.0

package/lib/ir/generated/types.d.ts

@@ -1,413 +0,0 @@
-import { Union, double, integer } from "../../utils/values.js";
-//#region src/ir/generated/types.d.ts
-/** A renderer-independent icon name from @party-stack/icons. */
-export type IconName = "activity" | "add" | "airplane" | "alarm" | "alert" | "archive" | "arrow-down" | "arrow-left" | "arrow-right" | "arrow-up" | "attachment" | "award" | "bank" | "barcode" | "bell" | "book" | "bookmark" | "briefcase" | "bug" | "building" | "calculator" | "calendar" | "camera" | "chart-bar" | "chart-line" | "chart-pie" | "chat" | "check" | "check-circle" | "chevron-down" | "chevron-left" | "chevron-right" | "chevron-up" | "circle" | "clipboard" | "clock" | "cloud" | "code" | "compass" | "copy" | "credit-card" | "cube" | "database" | "delete" | "document" | "download" | "edit" | "email" | "error" | "eye" | "eye-off" | "filter" | "flag" | "folder" | "globe" | "grid" | "heart" | "help" | "history" | "home" | "image" | "info" | "key" | "layers" | "lightbulb" | "link" | "list" | "location" | "lock" | "lock-open" | "map" | "menu" | "microphone" | "minus" | "minus-circle" | "moon" | "more-horizontal" | "more-vertical" | "notification" | "package" | "pause" | "people" | "person" | "phone" | "pin" | "play" | "play-circle" | "plus-circle" | "printer" | "project" | "refresh" | "rocket" | "save" | "search" | "send" | "settings" | "share" | "shield" | "shopping-bag" | "shopping-cart" | "star" | "stop" | "sun" | "tag" | "ticket" | "tools" | "upload" | "video" | "warning" | "window" | "wrench" | "x" | "x-circle";
-/** A portable icon descriptor with optional provider meta for lossless round trips. */
-export type IconDescriptor = {
-  /** Renderer-independent icon name. */
-  name: IconName;
-  /** Namespaced source-provider meta. */
-  meta?: Record<string, unknown>;
-};
-export type Deprecation = {
-  message: string;
-};
-/** A suggested value for a string. */
-export type StringSuggestion = {
-  value: string;
-  label?: string;
-};
-/** Constrains a string to a set of allowed values. */
-export type StringEnumConstraint = {
-  options: Array<StringSuggestion>;
-};
-/** Constrains a string to a regex. */
-export type StringRegexConstraint = {
-  regex: string;
-};
-/** A constraint that can be applied to a string type. */
-export type StringConstraint = Union<{
-  enum: StringEnumConstraint;
-  regex: StringRegexConstraint;
-}>;
-/** A string type with optional constraints. */
-export type StringTypeDef = {
-  constraint?: StringConstraint;
-  suggestions?: Array<StringSuggestion>;
-};
-/** A boolean type. */
-export type BooleanTypeDef = Record<never, never>;
-/** A 32-bit integer type. */
-export type IntegerTypeDef = Record<never, never>;
-/** A 32-bit floating point type. */
-export type FloatTypeDef = Record<never, never>;
-/** A 64-bit floating point type. */
-export type DoubleTypeDef = Record<never, never>;
-/** A date type (no time component). */
-export type DateTypeDef = Record<never, never>;
-/** A timestamp type (instant in time). */
-export type TimestampTypeDef = Record<never, never>;
-/** A geographic point (lat/lon). */
-export type GeopointTypeDef = Record<never, never>;
-/** An opaque type whose shape is not known at schema time. */
-export type UnknownTypeDef = Record<never, never>;
-/** A list/array type. */
-export type ListTypeDef = {
-  /** The type of elements in the list. */
-  elementType: TypeDef;
-};
-/** A map/record type. */
-export type MapTypeDef = {
-  /** The type of keys (must be string right now). */
-  keyType: TypeDef;
-  /** The type of values. */
-  valueType: TypeDef;
-};
-/** Definition of a field in a struct. */
-export type FieldDef = {
-  /** The field name in code. */
-  name: string;
-  /** Human-readable name. */
-  displayName: string;
-  /** The field's type. */
-  type: TypeDef;
-  /** Optional description. */
-  description?: string;
-  deprecated?: Deprecation;
-};
-/** A struct type with named fields. */
-export type StructTypeDef = {
-  fields: Array<FieldDef>;
-};
-/** Definition of a variant in a discriminated union. */
-export type VariantDef = {
-  /** The variant's discriminator value. */
-  name: string;
-  /** The variant's payload type. */
-  type: TypeDef;
-};
-/** A discriminated union type. */
-export type UnionTypeDef = {
-  variants: Array<VariantDef>;
-};
-/** Wraps a type to make it optional. */
-export type OptionalTypeDef = {
-  /** The wrapped type. */
-  type: TypeDef;
-};
-/** A result type (ok or error). */
-export type ResultTypeDef = {
-  /** The type of the success value. */
-  okType: TypeDef;
-  /** The type of the error value. */
-  errType: TypeDef;
-};
-/** A reference to a named type. */
-export type TypeRef = {
-  /** The name of the referenced type. */
-  name: string;
-};
-/** A type definition. Can be a primitive, collection, struct, union, optional, result, or reference. */
-export type TypeDef = Union<{
-  string: StringTypeDef;
-  boolean: BooleanTypeDef;
-  integer: IntegerTypeDef;
-  float: FloatTypeDef;
-  double: DoubleTypeDef;
-  date: DateTypeDef;
-  timestamp: TimestampTypeDef;
-  geopoint: GeopointTypeDef;
-  list: ListTypeDef;
-  map: MapTypeDef;
-  struct: StructTypeDef;
-  union: UnionTypeDef;
-  optional: OptionalTypeDef;
-  result: ResultTypeDef;
-  ref: TypeRef;
-  attachment: AttachmentTypeDef;
-  objectReference: ObjectReferenceTypeDef;
-  unknown: UnknownTypeDef;
-}>;
-/** A named type definition that can be referenced by other types. */
-export type NamedTypeDef = {
-  /** The type's name for use in code. */
-  name: string;
-  /** Optional documentation for the type. */
-  description?: string;
-  deprecated?: Deprecation;
-  /** The type definition. */
-  type: TypeDef;
-};
-/** A supported image media type. */
-export type ImageMediaType = "image/bmp" | "image/tiff" | "image/nitf" | "image/jp2" | "image/jpeg" | "image/png" | "image/gif" | "image/svg+xml" | "image/webp";
-/** Constrains intrinsic pixel dimensions. */
-export type DimensionsConstraint = {
-  width?: {
-    min?: integer;
-    max?: integer;
-  };
-  height?: {
-    min?: integer;
-    max?: integer;
-  };
-};
-/** Constraints specific to image attachments. */
-export type ImageAttachmentConstraint = {
-  mediaTypes?: Array<ImageMediaType>;
-  dimensions?: DimensionsConstraint;
-};
-/** Content-specific attachment constraints. */
-export type AttachmentContentConstraint = Union<{
-  image: ImageAttachmentConstraint;
-}>;
-/** Constraints applied to an attachment. */
-export type AttachmentConstraint = {
-  size?: {
-    min?: double;
-    max?: double;
-  };
-  content?: AttachmentContentConstraint;
-};
-/** A file handle with optional constraints. */
-export type AttachmentTypeDef = {
-  constraint?: AttachmentConstraint;
-  meta?: Record<string, unknown>;
-};
-/** A reference to an ontology object type. */
-export type ObjectReferenceTypeDef = {
-  /** The referenced object type name. */
-  objectType: string;
-};
-/** A property on an Object type. */
-export type PropertyDef = {
-  /** The property's name. */
-  name: string;
-  /** Human-readable name. */
-  displayName: string;
-  /** The property's type. */
-  type: TypeDef;
-  /** Optional description. */
-  description?: string;
-  deprecated?: Deprecation;
-};
-/** An object type in the ontology. */
-export type ObjectTypeDef = {
-  /** The object type's programmatic name. */
-  name: string;
-  /** Human-readable name. */
-  displayName: string;
-  pluralDisplayName: string;
-  /** The name of the property that serves as primary key. */
-  primaryKey: string;
-  /** The optional property name used as the human-readable title for an object. */
-  title?: string;
-  /** Optional portable icon descriptor. */
-  icon?: IconDescriptor;
-  /** Optional display color independent of the icon. */
-  color?: string;
-  /** The object type's propertieo. */
-  properties: Array<PropertyDef>;
-  /** Optional description. */
-  description?: string;
-  deprecated?: Deprecation;
-};
-export type LinkTypeSideDef = {
-  objectType: string;
-  name: string;
-  displayName: string;
-};
-/** The cardinality of a link from the source's perspective. */
-export type LinkCardinality = "one" | "many";
-/** A relationship between two object types. */
-export type LinkTypeDef = {
-  id: string;
-  source: LinkTypeSideDef;
-  target: LinkTypeSideDef;
-  /** The foreign key on the source. */
-  foreignKey: string;
-  /** How many sources are linked to the target. */
-  cardinality: "one" | "many";
-};
-/** A parameter of an Action type. */
-export type ActionParameterDef = {
-  /** The parameter's name. */
-  name: string;
-  /** Human-readable name. */
-  displayName: string;
-  /** The parameter's type. */
-  type: TypeDef;
-  /** Optional description. */
-  description?: string;
-  deprecated?: Deprecation;
-  /** The expression used when the caller does not provide a value. */
-  defaultValue?: Expression;
-};
-/** Reads a named input from the root expression scope. */
-export type InputReferenceExpression = {
-  name: string;
-};
-/** Reads a named lexically scoped expression binding. */
-export type LocalReferenceExpression = {
-  name: string;
-};
-/** Reads a named value from the expression context. */
-export type ContextReferenceExpression = {
-  name: string;
-};
-/** Reads a structural path from a source expression. */
-export type GetAtExpression = {
-  source: Expression;
-  path: Array<string>;
-};
-/** Resolves an object reference to its ontology object. */
-export type ObjectLookupExpression = {
-  reference: Expression;
-};
-/** Follows one named to-one ontology link from a source object. */
-export type LinkHopExpression = {
-  source: Expression;
-  link: string;
-};
-/** A named field constructed by a struct expression. */
-export type StructExpressionField = {
-  name: string;
-  value: Expression;
-};
-/** Constructs a struct value from field expressions. */
-export type StructExpression = {
-  fields: Array<StructExpressionField>;
-};
-/** Maps each element of a list to a new value. */
-export type MapExpression = {
-  source: Expression;
-  binding: string;
-  body: Expression;
-};
-/** Generates a UUID value. */
-export type UuidExpression = Record<never, never>;
-/** Returns the current timestamp. */
-export type NowExpression = Record<never, never>;
-/** A static literal value. */
-export type LiteralExpression = {
-  /** The literal value. */
-  value: unknown;
-};
-/** An expression that resolves to a value. */
-export type Expression = Union<{
-  inputReference: InputReferenceExpression;
-  contextReference: ContextReferenceExpression;
-  localReference: LocalReferenceExpression;
-  getAt: GetAtExpression;
-  objectLookup: ObjectLookupExpression;
-  linkHop: LinkHopExpression;
-  struct: StructExpression;
-  map: MapExpression;
-  uuid: UuidExpression;
-  now: NowExpression;
-  literal: LiteralExpression;
-}>;
-/** Assigns an expression to a property path on an object written by an action. */
-export type PropertyAssignment = {
-  property: Array<string>;
-  value: Expression;
-};
-/** Creates an object and assigns property values. */
-export type CreateObjectActionLogicStep = {
-  objectType: string;
-  values: Array<PropertyAssignment>;
-};
-/** Updates a referenced object and assigns property values. */
-export type UpdateObjectActionLogicStep = {
-  object: InputReferenceExpression;
-  values: Array<PropertyAssignment>;
-};
-/** Deletes a referenced object. */
-export type DeleteObjectActionLogicStep = {
-  object: InputReferenceExpression;
-};
-/** A logic step performed by an action. */
-export type ActionLogicStep = Union<{
-  createObject: CreateObjectActionLogicStep;
-  updateObject: UpdateObjectActionLogicStep;
-  deleteObject: DeleteObjectActionLogicStep;
-}>;
-/** An action type in the ontology. */
-export type ActionTypeDef = {
-  /** Provider-specific metadata used to execute this action. */
-  meta?: Record<string, unknown>;
-  /** The object type's programmatic name. */
-  name: string;
-  /** Human-readable name. */
-  displayName: string;
-  /** Optional portable icon descriptor. */
-  icon?: IconDescriptor;
-  /** Optional display color independent of the icon. */
-  color?: string;
-  /** The action type's parametero. */
-  parameters: Array<ActionParameterDef>;
-  /** The action type's local logic stepo. */
-  logic: Array<ActionLogicStep>;
-  /** Optional description. */
-  description?: string;
-  deprecated?: Deprecation;
-};
-/** A parameter accepted by a query function type. */
-export type QueryFunctionParameterDef = {
-  /** The query function parameter's programmatic name. */
-  name: string;
-  /** Human-readable name. */
-  displayName: string;
-  type: TypeDef;
-  /** Optional description. */
-  description?: string;
-  deprecated?: Deprecation;
-};
-/** A runnable query function type in the ontology. */
-export type QueryFunctionTypeDef = {
-  /** The query function type's programmatic name. */
-  name: string;
-  /** Human-readable name. */
-  displayName: string;
-  /** The query function type's parameters. */
-  parameters: Array<QueryFunctionParameterDef>;
-  /** The query function type's return type. */
-  returnType: TypeDef;
-  /** Optional description. */
-  description?: string;
-  deprecated?: Deprecation;
-};
-/** Moves a property from one path to another. */
-export type MoveLensOp = {
-  from: Array<string>;
-  to: Array<string>;
-};
-/** Retains only the selected top-level properties. */
-export type SelectLensOp = {
-  properties: Array<string>;
-};
-/** One schema and value transformation operation. */
-export type LensOp = Union<{
-  move: MoveLensOp;
-  select: SelectLensOp;
-}>;
-/** An ordered sequence of source-to-target transformation operations. */
-export type Lens = {
-  operations: Array<LensOp>;
-};
-/** The root ontology definition containing all type definitions. */
-export type OntologyIR = {
-  /** Named, reusable value types. */
-  types: Array<NamedTypeDef>;
-  /** Object type definitions. */
-  objectTypes: Array<ObjectTypeDef>;
-  /** Relationship definitions between object types. */
-  linkTypes: Array<LinkTypeDef>;
-  /** Action type definitions. */
-  actionTypes: Array<ActionTypeDef>;
-  /** Query function type definitions. */
-  queryFunctionTypes: Array<QueryFunctionTypeDef>;
-  /** Optional typed execution context available to ontology expressions. */
-  contextType?: TypeDef;
-};
-//#endregion
-//# sourceMappingURL=types.d.ts.map

package/lib/ir/generated/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","names":["v.Union","v.integer","v.double"],"sources":["../../../src/ir/generated/types.ts"],"mappings":";;;YAKY;;YAoHA;;EAER,MAAM;;EAEN,OAAO;;YAGC;EACR;;;YAIQ;EACR;EACA;;;YAIQ;EACR,SAAS,MAAM;;;YAIP;EACR;;;YAIQ,mBAAmBA;EAC3B,MAAM;EACN,OAAO;;;YAIC;EACR,aAAa;EACb,cAAc,MAAM;;;YAIZ,iBAAiB;;YAGjB,iBAAiB;;YAGjB,eAAe;;YAGf,gBAAgB;;YAGhB,cAAc;;YAGd,mBAAmB;;YAGnB,kBAAkB;;YAGlB,iBAAiB;;YAGjB;;EAER,aAAa;;;YAIL;;EAER,SAAS;;EAET,WAAW;;;YAIH;;EAER;;EAEA;;EAEA,MAAM;;EAEN;EACA,aAAa;;;YAIL;EACR,QAAQ,MAAM;;;YAIN;;EAER;;EAEA,MAAM;;;YAIE;EACR,UAAU,MAAM;;;YAIR;;EAER,MAAM;;;YAIE;;EAER,QAAQ;;EAER,SAAS;;;YAID;;EAER;;;YAIQ,UAAUA;EAClB,QAAQ;EACR,SAAS;EACT,SAAS;EACT,OAAO;EACP,QAAQ;EACR,MAAM;EACN,WAAW;EACX,UAAU;EACV,MAAM;EACN,KAAK;EACL,QAAQ;EACR,OAAO;EACP,UAAU;EACV,QAAQ;EACR,KAAK;EACL,YAAY;EACZ,iBAAiB;EACjB,SAAS;;;YAID;;EAER;;EAEA;EACA,aAAa;;EAEb,MAAM;;;YAIE;;YAYA;EACR;IACI,MAAMC;IACN,MAAMA;;EAEV;IACI,MAAMA;IACN,MAAMA;;;;YAKF;EACR,aAAa,MAAM;EACnB,aAAa;;;YAIL,8BAA8BD;EACtC,OAAO;;;YAIC;EACR;IACI,MAAME;IACN,MAAMA;;EAEV,UAAU;;;YAIF;EACR,aAAa;EACb,OAAO;;;YAIC;;EAER;;;YAIQ;;EAER;;EAEA;;EAEA,MAAM;;EAEN;EACA,aAAa;;;YAIL;;EAER;;EAEA;EACA;;EAEA;;EAEA;;EAEA,OAAO;;EAEP;;EAEA,YAAY,MAAM;;EAElB;EACA,aAAa;;YAGL;EACR;EACA;EACA;;;YAIQ;;YAGA;EACR;EACA,QAAQ;EACR,QAAQ;;EAER;;EAEA;;;YAIQ;;EAER;;EAEA;;EAEA,MAAM;;EAEN;EACA,aAAa;;EAEb,eAAe;;;YAIP;EACR;;;YAIQ;EACR;;;YAIQ;EACR;;;YAIQ;EACR,QAAQ;EACR,MAAM;;;YAIE;EACR,WAAW;;;YAIH;EACR,QAAQ;EACR;;;YAIQ;EACR;EACA,OAAO;;;YAIC;EACR,QAAQ,MAAM;;;YAIN;EACR,QAAQ;EACR;EACA,MAAM;;;YAIE,iBAAiB;;YAGjB,gBAAgB;;YAGhB;;EAER;;;YAIQ,aAAaF;EACrB,gBAAgB;EAChB,kBAAkB;EAClB,gBAAgB;EAChB,OAAO;EACP,cAAc;EACd,SAAS;EACT,QAAQ;EACR,KAAK;EACL,MAAM;EACN,KAAK;EACL,SAAS;;;YAID;EACR,UAAU;EACV,OAAO;;;YAIC;EACR;EACA,QAAQ,MAAM;;;YAIN;EACR,QAAQ;EACR,QAAQ,MAAM;;;YAIN;EACR,QAAQ;;;YAIA,kBAAkBA;EAC1B,cAAc;EACd,cAAc;EACd,cAAc;;;YAIN;;EAER,OAAO;;EAEP;;EAEA;;EAEA,OAAO;;EAEP;;EAEA,YAAY,MAAM;;EAElB,OAAO,MAAM;;EAEb;EACA,aAAa;;;YAIL;;EAER;;EAEA;EACA,MAAM;;EAEN;EACA,aAAa;;;YAIL;;EAER;;EAEA;;EAEA,YAAY,MAAM;;EAElB,YAAY;;EAEZ;EACA,aAAa;;;YAIL;EACR,MAAM;EACN,IAAI;;;YAII;EACR,YAAY;;;YAIJ,SAASA;EACjB,MAAM;EACN,QAAQ;;;YAIA;EACR,YAAY,MAAM;;;YAIV;;EAER,OAAO,MAAM;;EAEb,aAAa,MAAM;;EAEnB,WAAW,MAAM;;EAEjB,aAAa,MAAM;;EAEnB,oBAAoB,MAAM;;EAE1B,cAAc"}

package/lib/ir/index.d.ts

@@ -1,4 +0,0 @@
-import { ActionLogicStep, ActionParameterDef, ActionTypeDef, AttachmentConstraint, AttachmentContentConstraint, AttachmentTypeDef, BooleanTypeDef, ContextReferenceExpression, CreateObjectActionLogicStep, DateTypeDef, DeleteObjectActionLogicStep, Deprecation, DimensionsConstraint, DoubleTypeDef, Expression, FieldDef, FloatTypeDef, GeopointTypeDef, GetAtExpression, IconDescriptor, IconName, ImageAttachmentConstraint, ImageMediaType, InputReferenceExpression, IntegerTypeDef, Lens, LensOp, LinkCardinality, LinkHopExpression, LinkTypeDef, LinkTypeSideDef, ListTypeDef, LiteralExpression, LocalReferenceExpression, MapExpression, MapTypeDef, MoveLensOp, NamedTypeDef, NowExpression, ObjectLookupExpression, ObjectReferenceTypeDef, ObjectTypeDef, OntologyIR, OptionalTypeDef, PropertyAssignment, PropertyDef, QueryFunctionParameterDef, QueryFunctionTypeDef, ResultTypeDef, SelectLensOp, StringConstraint, StringEnumConstraint, StringRegexConstraint, StringSuggestion, StringTypeDef, StructExpression, StructExpressionField, StructTypeDef, TimestampTypeDef, TypeDef, TypeRef, UnionTypeDef, UnknownTypeDef, UpdateObjectActionLogicStep, UuidExpression, VariantDef } from "./generated/types.js";
-import { o } from "./generated/builders.js";
-import { ValidationResult, validate } from "./validate.js";
-export { ActionLogicStep, ActionParameterDef, ActionTypeDef, AttachmentConstraint, AttachmentContentConstraint, AttachmentTypeDef, BooleanTypeDef, ContextReferenceExpression, CreateObjectActionLogicStep, DateTypeDef, DeleteObjectActionLogicStep, Deprecation, DimensionsConstraint, DoubleTypeDef, Expression, FieldDef, FloatTypeDef, GeopointTypeDef, GetAtExpression, IconDescriptor, IconName, ImageAttachmentConstraint, ImageMediaType, InputReferenceExpression, IntegerTypeDef, Lens, LensOp, LinkCardinality, LinkHopExpression, LinkTypeDef, LinkTypeSideDef, ListTypeDef, LiteralExpression, LocalReferenceExpression, MapExpression, MapTypeDef, MoveLensOp, NamedTypeDef, NowExpression, ObjectLookupExpression, ObjectReferenceTypeDef, ObjectTypeDef, OntologyIR, OptionalTypeDef, PropertyAssignment, PropertyDef, QueryFunctionParameterDef, QueryFunctionTypeDef, ResultTypeDef, SelectLensOp, StringConstraint, StringEnumConstraint, StringRegexConstraint, StringSuggestion, StringTypeDef, StructExpression, StructExpressionField, StructTypeDef, TimestampTypeDef, TypeDef, TypeRef, UnionTypeDef, UnknownTypeDef, UpdateObjectActionLogicStep, UuidExpression, ValidationResult, VariantDef, o, validate };

package/lib/ir/index.js

@@ -1,3 +0,0 @@
-import { o } from "./generated/builders.js";
-import { validate } from "./validate.js";
-export { o, validate };