@api-client/core 0.14.2 → 0.14.4

package/build/src/modeling/types.d.ts

@@ -176,4 +176,495 @@ export type DataDomainGraph = Graph<unknown, DomainGraphNodeType, DomainGraphEdg
  * The serialized version of the data domain graph.
  */
 export type SerializedGraph = GraphJson<unknown, object, DomainGraphEdge>;
+/**
+ * Represents a standardized, machine-readable error response body
+ * as defined by RFC 7807 for HTTP APIs.
+ */
+export interface ProblemDetails {
+    /**
+     * A URI that identifies the specific problem type. Should resolve to human-readable docs.
+     * e.g., "https://docs.apinow.app/errors/validation-failed"
+     */
+    type: string;
+    /**
+     * A short, human-readable summary of the problem type.
+     * e.g., "Validation Error"
+     */
+    title: string;
+    /**
+     * The HTTP status code generated by the origin server for this problem.
+     */
+    status?: number;
+    /**
+     * A human-readable explanation specific to this occurrence of the problem.
+     */
+    detail?: string;
+    /**
+     * A URI that identifies the specific occurrence of the problem.
+     * Can be the API request path that caused the error.
+     */
+    instance: string;
+}
+/**
+ * The set of supported filter operators for the List action.
+ * These are used in query parameters, e.g., ?price[gte]=100
+ *
+ * - eq: Equal
+ * - nq: Not Equal
+ * - lt: Less Than
+ * - lte: Less Than or Equal
+ * - gt: Greater Than
+ * - gte: Greater Than or Equal
+ * - ex: Checks if the field exists
+ * - re: Regular expression match
+ * - bf: Date before a specific value
+ * - af: Date after a specific value
+ * - cn: String contains substring / Array contains element
+ * - st: String starts with
+ * - end: String ends with
+ * - in: Value is one of the elements in the provided array
+ * - nin: Value is not one of the elements in the provided array
+ */
+export type ResourceFilterOperator = 'eq' | 'nq' | 'lt' | 'lte' | 'gt' | 'gte' | 'ex' | 're' | 'bf' | 'af' | 'cn' | 'st' | 'end' | 'in' | 'nin';
+/**
+ * The session transport configuration interface.
+ * This defines the properties that are common to all session transports.
+ */
+interface SessionTransport {
+    /**
+     * Whether the session transport is enabled.
+     */
+    enabled: boolean;
+    /**
+     * The kind of session transport. Each interface defines its own kind.
+     */
+    kind: string;
+}
+/**
+ * Configuration for cookie-based session transport.
+ */
+export interface CookieConfiguration extends SessionTransport {
+    kind: 'cookie';
+    /**
+     * The lifetime of the cookie session.
+     * This is a string representing the duration, e.g., "7d" for 7 days or "24h" for 24 hours.
+     *
+     * @default "7d"
+     */
+    lifetime: string;
+    /**
+     * Whether the cookie can only be accessed by the server.
+     * This is a security feature to prevent client-side scripts from accessing the cookie.
+     * If set to false, the cookie can be accessed by client-side scripts.
+     * @default true
+     */
+    httpOnly: boolean;
+    /**
+     * Whether the cookie should only be sent over secure connections (HTTPS).
+     * This is a security feature to prevent the cookie from being sent over unencrypted connections.
+     * @default true
+     */
+    secure: boolean;
+    /**
+     * The SameSite attribute of the cookie.
+     * This attribute controls whether the cookie is sent with cross-site requests.
+     * - 'none' means the cookie is sent with cross-site requests.
+     * - 'lax' means the cookie is sent with top-level navigations and will be sent along with GET
+     *   requests initiated by third-party websites.
+     * @default 'none'
+     */
+    sameSite: 'none' | 'lax';
+    /**
+     * The name of the cookie.
+     * This is the key under which the session data will be stored in the cookie.
+     * @default 'as' - 'as' stands for "api session"
+     */
+    name: string;
+}
+/**
+ * Configuration for JWT-based session transport.
+ */
+export interface JwtConfiguration extends SessionTransport {
+    kind: 'jwt';
+    /**
+     * The lifetime of the JWT token.
+     * This is a string representing the duration, e.g., "7d" for 7 days or "15m" for 15 minutes.
+     *
+     * @default "7d"
+     */
+    lifetime: string;
+}
+export interface SessionConfiguration {
+    /**
+     * The secret used to sign the JWT and cookies. Should be handled securely.
+     * Not visible in the UI after being set.
+     */
+    secret: string;
+    /**
+     * The properties from the `User` entity to be encoded into the session payload (JWT/cookie).
+     * These properties become available in the `request.auth` object at runtime.
+     */
+    properties: string[];
+    /**
+     * The cookie-based session transport configuration.
+     */
+    cookie?: CookieConfiguration;
+    /**
+     * The JWT-based session transport configuration.
+     */
+    jwt?: JwtConfiguration;
+}
+/**
+ * Defines the authorization strategy for the API.
+ * It is a base interface that can be extended for different strategies.
+ * For MVP, we will start with Roles-Based Access Control (RBAC).
+ */
+export interface AuthorizationConfiguration {
+    /**
+     * The authorization strategy. For MVP, we will start with RBAC.
+     * Post-MVP will include Permission-Based Access Control (PBAC).
+     * The strategy determines how users are granted access to resources.
+     *
+     * - RBAC (Roles-Based Access Control): Users are assigned roles, and permissions are granted to those roles.
+     * - PBAC (Permission-Based Access Control): Users are granted permissions directly, allowing for more
+     *   granular control.
+     */
+    strategy: string;
+}
+export interface RolesBasedAccessControl extends AuthorizationConfiguration {
+    strategy: 'RBAC';
+    /**
+     * The property within the designated "User" entity that defines the user's role.
+     * This field is used in access rules to grant permissions.
+     *
+     * This property must be marked with the "Role" data semantic in the Data Modeler.
+     * It is required to publish the API.
+     */
+    roleKey: string;
+}
+/**
+ * Configures the strategy for authenticating end-users.
+ * An API can only support one authentication strategy at a time.
+ * This is a base interface that can be extended for different strategies.
+ */
+export interface AuthenticationConfiguration {
+    /**
+     * The authentication method. For MVP, this is focused on username/password.
+     * This can be extended in the future to include 'SSO'.
+     */
+    strategy: string;
+}
+/**
+ * Configuration for username/password authentication.
+ * This is the primary authentication method for the API (MVP).
+ */
+export interface UsernamePasswordConfiguration extends AuthenticationConfiguration {
+    strategy: 'UsernamePassword';
+    /**
+     * The specific property within the User entity that holds the password.
+     * This property must be marked with the "Password" data semantic in the Data Modeler.
+     *
+     * This property is required to publish the API.
+     */
+    passwordKey?: string;
+}
+/**
+ * Represents a Data Entity from the Data Domain that the API will expose and operate upon.
+ */
+export interface ExposedEntity {
+    /**
+     * The key of the Data Entity from the Data Domain.
+     */
+    key: string;
+    /**
+     * Optional configuration for resource-wide rate limiting and throttling.
+     * Defines rules to protect the resource from overuse.
+     */
+    rateLimiting?: RateLimitingConfiguration;
+    /**
+     * Access control rules defining who can perform actions on this resource or collection.
+     * It override the top-level access rules defined in the API model.
+     */
+    accessRule?: AccessRule[];
+    /**
+     * The collection of API actions (e.g., List, Read, Create) enabled for this entity.
+     */
+    actions: ApiAction[];
+}
+/**
+ * Represents a specific, configurable API operation applied to a Data Entity.
+ * Corresponds to common RESTful interactions.
+ */
+export type ApiAction = ListAction | ReadAction | CreateAction | UpdateAction | DeleteAction | SearchAction;
+/**
+ * A base interface for common properties across all actions.
+ */
+interface Action {
+    /**
+     * The specific kind of action (e.g., 'List', 'Read', etc.)
+     */
+    kind: string;
+    /**
+     * Access control rules defining who can perform this action. It is only applied if the
+     * authorization strategy is set to 'RBAC'.
+     * If no rules grant access, it's denied by default making it essentially private.
+     *
+     * Note, the API can defined top level access rules that apply to all actions. If this property is set,
+     * it overrides the top level access rules for this specific action.
+     *
+     * It is an ordered list, meaning the first rule that matches the user will be applied.
+     * If multiple rules match, the first one in the list takes precedence.
+     * If no rules match, the action is denied.
+     */
+    accessRule?: AccessRule[];
+    /**
+     * Optional configuration for action-wide rate limiting and throttling.
+     * Defines rules to protect the action from overuse.
+     */
+    rateLimiting?: RateLimitingConfiguration;
+}
+/**
+ * Represents a pagination strategy for API actions that return collections of resources.
+ * This is a base interface that can be extended for different pagination strategies.
+ */
+export interface PaginationStrategy {
+    /**
+     * The kind of pagination strategy. This is used to identify the specific pagination method.
+     * For example, 'cursor' for cursor-based pagination or 'offset' for offset-based pagination.
+     */
+    kind: string;
+    /**
+     * The default page size for the pagination strategy.
+     * This is the number of items returned per page when no specific page size is requested.
+     */
+    pageSize?: number;
+}
+/**
+ * Represents the cursor-based pagination strategy.
+ */
+export interface CursorPaginationStrategy extends PaginationStrategy {
+    kind: 'cursor';
+}
+/**
+ * Represents the offset-based pagination strategy.
+ */
+export interface OffsetPaginationStrategy extends PaginationStrategy {
+    kind: 'offset';
+}
+/**
+ * Enables retrieving a collection of resources.
+ * Endpoint: GET /[entity-collection-name]
+ */
+export interface ListAction extends Action {
+    kind: 'list';
+    /**
+     * The pagination strategy used for this action.
+     * This defines how the results are paginated when retrieving a collection of resources.
+     * It can be either 'cursor' or 'offset'.
+     */
+    pagination: PaginationStrategy;
+    /**
+     * Fields from the entity that can be used for filtering.
+     * Must be marked as "indexable" in the Data Model.
+     */
+    filterableFields: string[];
+    /**
+     * Fields from the entity that can be used for sorting.
+     */
+    sortableFields: string[];
+}
+/**
+ * Enables retrieving a single resource by its ID.
+ * Endpoint: GET /[entity-collection-name]/{id}
+ */
+export interface ReadAction extends Action {
+    kind: 'read';
+}
+/**
+ * Enables adding a new resource to a collection.
+ * Endpoint: POST /[entity-collection-name]
+ */
+export interface CreateAction extends Action {
+    kind: 'create';
+}
+/**
+ * Enables modifying an existing resource.
+ * Endpoints: PUT or PATCH /[entity-collection-name]/{id}
+ */
+export interface UpdateAction extends Action {
+    kind: 'update';
+    /**
+     * The allowed HTTP methods for updates. Default: PATCH only.
+     *
+     * These two methods represent the two common ways to update a resource:
+     * - PUT: Replaces the entire resource with the provided data.
+     * - PATCH: Applies a partial update to the resource, allowing for specific fields to be modified.
+     */
+    allowedMethods: ('PUT' | 'PATCH')[];
+}
+/**
+ * Enables removing an existing resource.
+ * Endpoint: DELETE /[entity-collection-name]/{id}
+ */
+export interface DeleteAction extends Action {
+    kind: 'delete';
+    /**
+     * The strategy for deletion. Default: Soft Delete.
+     *
+     * @default 'soft'
+     */
+    strategy?: 'soft' | 'hard';
+}
+/**
+ * Enables keyword-based search across specified fields.
+ * Endpoint: GET /[entity-collection-name]/search
+ */
+export interface SearchAction extends Action {
+    kind: 'search';
+    /**
+     * The fields within the entity to be included in the search scope.
+     * Must be "indexable" and typically text-based.
+     */
+    fields: string[];
+}
+/**
+ * Defines the access control policy for a specific API action.
+ * Based on the predefined rule types for session-based authentication.
+ */
+export type AccessRule = AllowPublicAccessRule | AllowAuthenticatedAccessRule | MatchResourceOwnerAccessRule | MatchUserRoleAccessRule | MatchUserPropertyAccessRule | MatchEmailDomainAccessRule;
+export interface BaseAccessRule {
+    /**
+     * The unique identifier for the access rule.
+     * This is used to reference the rule in the API configuration.
+     */
+    type: string;
+}
+/**
+ * The action is allowed for all users, including unauthenticated ones.
+ * This is typically used for public APIs or resources that do not require authentication.
+ * It is the most permissive rule and should be used with caution.
+ */
+export interface AllowPublicAccessRule extends BaseAccessRule {
+    type: 'public';
+}
+/**
+ * The action is allowed for any authenticated user.
+ * This rule does not impose any additional restrictions based on user properties or resource ownership.
+ * It is used for resources that should be accessible to all logged-in users.
+ */
+export interface AllowAuthenticatedAccessRule extends BaseAccessRule {
+    type: 'authenticated';
+}
+/**
+ * The action is allowed if the authenticated user's ID matches a specific property on the resource.
+ * This is typically used to restrict access to resources owned by the user.
+ * For example, a user can only access their own profile or documents.
+ */
+export interface MatchResourceOwnerAccessRule extends BaseAccessRule {
+    type: 'resourceOwner';
+    /**
+     * The property on the resource that should match the authenticated user's ID.
+     * This is typically the ID of the user who owns the resource.
+     *
+     * The domain model should annotate this property with the "ResourceOwnerIdentifier" semantic
+     * to indicate that it is used for ownership checks.
+     */
+    property: string;
+}
+/**
+ * The action is allowed if the authenticated user has a specific role.
+ * This is used to enforce role-based access control (RBAC).
+ * For example, only users with the "admin" role can perform certain actions.
+ */
+export interface MatchUserRoleAccessRule extends BaseAccessRule {
+    type: 'matchUserRole';
+    /**
+     * The role that the authenticated user must have to access the resource.
+     * This is typically a property on the user entity that defines their role.
+     *
+     * The domain model should annotate this property with the "UserRole" semantic
+     * to indicate that it is used for role-based access control.
+     */
+    role: string;
+}
+/**
+ * The action is allowed if a specific property on the authenticated user matches an expected value.
+ * This is used to enforce other user-specific restrictions.
+ */
+export interface MatchUserPropertyAccessRule extends BaseAccessRule {
+    type: 'matchUserProperty';
+    /**
+     * The property on the authenticated user that should match the expected value.
+     */
+    property: string;
+    /**
+     * The expected value for the user property.
+     */
+    value: string;
+}
+/**
+ * The action is allowed if the authenticated user's email domain matches a specific domain.
+ * This is used to restrict access based on the user's email address.
+ * For example, only users with an email address from "mycompany.com" can access certain resources.
+ */
+export interface MatchEmailDomainAccessRule extends BaseAccessRule {
+    type: 'matchEmailDomain';
+    /**
+     * The email domain that the authenticated user's email must match.
+     */
+    domain: string;
+}
+/**
+ * Defines the rate limiting and throttling policies for the entire API.
+ */
+export interface RateLimitingConfiguration {
+    /**
+     * An ordered list of rules. The first rule that matches an incoming
+     * request will be applied.
+     */
+    rules: RateLimitRule[];
+}
+/**
+ * Represents a single rate limiting rule that applies to a specific
+ * type of client, using a token bucket algorithm.
+ */
+export interface RateLimitRule {
+    /**
+     * A human-readable description of what this rule is for.
+     * e.g., "Limit anonymous users to 60 requests per hour."
+     */
+    description?: string;
+    /**
+     * Defines how to group requests for rate limiting. This determines
+     * who the limit applies to.
+     *
+     * - 'ip': Keys on the client's IP address. Best for anonymous traffic.
+     * - 'userId': Keys on the authenticated user's ID. Best for logged-in users.
+     * - 'role': Applies a shared limit to all users of a specific role.
+     */
+    key: {
+        type: 'ip';
+    } | {
+        type: 'userId';
+    } | {
+        type: 'role';
+        value: string;
+    };
+    /**
+     * The number of requests allowed over the defined interval.
+     * This is the rate at which tokens are added to the bucket.
+     */
+    rate: number;
+    /**
+     * The time interval for the rate.
+     */
+    interval: 'second' | 'minute' | 'hour' | 'day';
+    /**
+     * The maximum number of requests that can be made in a burst.
+     * This represents the "bucket size." A larger burst allows for
+     * more requests to be made in a short period before throttling begins.
+     */
+    burst: number;
+}
+export {};
 //# sourceMappingURL=types.d.ts.map

package/build/src/modeling/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/modeling/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAA;AACjE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kCAAkC,CAAA;AAC7D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC/D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAEzD,MAAM,WAAW,uBAAuB;IACtC;;;;;;;;;OASG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;;;;;;;;;OAYG;IACH,IAAI,EAAE,aAAa,GAAG,UAAU,GAAG,QAAQ,CAAA;CAC5C;AAED,MAAM,MAAM,mBAAmB,GAAG,eAAe,GAAG,WAAW,GAAG,YAAY,GAAG,cAAc,GAAG,iBAAiB,CAAA;AAEnH;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,IAAI,EAAE,SAAS,GAAG,UAAU,CAAA;IAC5B;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf;;;OAGG;IACH,YAAY,CAAC,EAAE,kBAAkB,CAAA;IACjC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC,OAAO,EAAE,mBAAmB,EAAE,eAAe,CAAC,CAAA;AAClF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,eAAe,CAAC,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/modeling/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAA;AACjE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kCAAkC,CAAA;AAC7D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC/D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAEzD,MAAM,WAAW,uBAAuB;IACtC;;;;;;;;;OASG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;;;;;;;;;OAYG;IACH,IAAI,EAAE,aAAa,GAAG,UAAU,GAAG,QAAQ,CAAA;CAC5C;AAED,MAAM,MAAM,mBAAmB,GAAG,eAAe,GAAG,WAAW,GAAG,YAAY,GAAG,cAAc,GAAG,iBAAiB,CAAA;AAEnH;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,IAAI,EAAE,SAAS,GAAG,UAAU,CAAA;IAC5B;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf;;;OAGG;IACH,YAAY,CAAC,EAAE,kBAAkB,CAAA;IACjC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC,OAAO,EAAE,mBAAmB,EAAE,eAAe,CAAC,CAAA;AAClF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,eAAe,CAAC,CAAA;AAEzE;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,sBAAsB,GAC9B,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,KAAK,CAAA;AAET;;;GAGG;AACH,UAAU,gBAAgB;IACxB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D,IAAI,EAAE,QAAQ,CAAA;IACd;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;;;;OAKG;IACH,QAAQ,EAAE,OAAO,CAAA;IACjB;;;;OAIG;IACH,MAAM,EAAE,OAAO,CAAA;IACf;;;;;;;OAOG;IACH,QAAQ,EAAE,MAAM,GAAG,KAAK,CAAA;IACxB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD,IAAI,EAAE,KAAK,CAAA;IACX;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAA;IAE5B;;OAEG;IACH,GAAG,CAAC,EAAE,gBAAgB,CAAA;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;;;;;OAQG;IACH,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,uBAAwB,SAAQ,0BAA0B;IACzE,QAAQ,EAAE,MAAM,CAAA;IAChB;;;;;;OAMG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,6BAA8B,SAAQ,2BAA2B;IAChF,QAAQ,EAAE,kBAAkB,CAAA;IAC5B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IAEX;;;OAGG;IACH,YAAY,CAAC,EAAE,yBAAyB,CAAA;IACxC;;;OAGG;IACH,UAAU,CAAC,EAAE,UAAU,EAAE,CAAA;IAEzB;;OAEG;IACH,OAAO,EAAE,SAAS,EAAE,CAAA;CACrB;AAED;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,YAAY,GAAG,YAAY,GAAG,YAAY,GAAG,YAAY,CAAA;AAE3G;;GAEG;AACH,UAAU,MAAM;IACd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,EAAE,UAAU,EAAE,CAAA;IACzB;;;OAGG;IACH,YAAY,CAAC,EAAE,yBAAyB,CAAA;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,kBAAkB;IAClE,IAAI,EAAE,QAAQ,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,kBAAkB;IAClE,IAAI,EAAE,QAAQ,CAAA;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,MAAM;IACxC,IAAI,EAAE,MAAM,CAAA;IACZ;;;;OAIG;IACH,UAAU,EAAE,kBAAkB,CAAA;IAC9B;;;OAGG;IACH,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B;;OAEG;IACH,cAAc,EAAE,MAAM,EAAE,CAAA;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,MAAM;IACxC,IAAI,EAAE,MAAM,CAAA;CAGb;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,MAAM;IAC1C,IAAI,EAAE,QAAQ,CAAA;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,MAAM;IAC1C,IAAI,EAAE,QAAQ,CAAA;IACd;;;;;;OAMG;IACH,cAAc,EAAE,CAAC,KAAK,GAAG,OAAO,CAAC,EAAE,CAAA;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,MAAM;IAC1C,IAAI,EAAE,QAAQ,CAAA;IACd;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,MAAM;IAC1C,IAAI,EAAE,QAAQ,CAAA;IACd;;;OAGG;IACH,MAAM,EAAE,MAAM,EAAE,CAAA;CACjB;AAED;;;GAGG;AACH,MAAM,MAAM,UAAU,GAClB,qBAAqB,GACrB,4BAA4B,GAC5B,4BAA4B,GAC5B,uBAAuB,GACvB,2BAA2B,GAC3B,0BAA0B,CAAA;AAE9B,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAsB,SAAQ,cAAc;IAC3D,IAAI,EAAE,QAAQ,CAAA;CACf;AACD;;;;GAIG;AACH,MAAM,WAAW,4BAA6B,SAAQ,cAAc;IAClE,IAAI,EAAE,eAAe,CAAA;CACtB;AACD;;;;GAIG;AACH,MAAM,WAAW,4BAA6B,SAAQ,cAAc;IAClE,IAAI,EAAE,eAAe,CAAA;IACrB;;;;;;OAMG;IACH,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAwB,SAAQ,cAAc;IAC7D,IAAI,EAAE,eAAe,CAAA;IACrB;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AACD;;;GAGG;AACH,MAAM,WAAW,2BAA4B,SAAQ,cAAc;IACjE,IAAI,EAAE,mBAAmB,CAAA;IACzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd;AACD;;;;GAIG;AACH,MAAM,WAAW,0BAA2B,SAAQ,cAAc;IAChE,IAAI,EAAE,kBAAkB,CAAA;IACxB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,KAAK,EAAE,aAAa,EAAE,CAAA;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;;;;OAOG;IACH,GAAG,EAAE;QAAE,IAAI,EAAE,IAAI,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,QAAQ,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IAE1E;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,QAAQ,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAA;IAE9C;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAA;CACd"}

package/build/src/modeling/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/modeling/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { GraphJson } from '@api-client/graph/graph/types.js'\nimport type { Graph } from '@api-client/graph/graph/Graph.js'\nimport type { DomainAssociation } from './DomainAssociation.js'\nimport type { DomainEntity } from './DomainEntity.js'\nimport type { DomainModel } from './DomainModel.js'\nimport type { DomainNamespace } from './DomainNamespace.js'\nimport type { DomainProperty } from './DomainProperty.js'\n\nexport interface DataDomainRemoveOptions {\n  /**\n   * When true, the object will be forcibly removed.\n   * The resolution defined in the `ImpactResolution` class will be applied.\n   *\n   * For example, when removing an entity that is a parent to another entity, it will\n   * removed itself as a parent from the child entity.\n   *\n   * Note, this option should only be used when the DomainImpactAnalysis has been performed\n   * and the user was informed of the impact.\n   */\n  force?: boolean\n}\n\nexport interface AssociationAddOptions {\n  /**\n   * When set, it is the the association target's origin data domain.\n   * The key of the target data domain where this target entity is defined.\n   * Only used when `key` is specified.\n   */\n  domain?: string\n  /**\n   * The key of the association target, if known.\n   * If the target of the association is not specified, and the association has no other targets,\n   * the association is ignored in the namespace while processing.\n   */\n  key?: string\n}\n\nexport interface DomainGraphEdge {\n  /**\n   * Indicates that the edge is to or from a foreign domain.\n   */\n  foreign?: boolean\n  /**\n   * The key of the foreign domain. Always set with the `foreign` property.\n   */\n  domain?: string\n  /**\n   * The type of the edge.\n   * - `association` The edge is to an association object.\n   *   - When coming **from** an entiry (the `v` property), that entity owns the association.\n   *   - When coming **to** an entity (the `w` property), that entity is the target of the association.\n   *     An association can have multiple targets.\n   * - `property` The edge is to a property object. Can only be created between an entity and a property.\n   *   - The **from** (`v`) is the entity.\n   *   - The **to** (`w`) is the property.\n   * - `parent` The edge is to a parent object.\n   *   - The **from** (`v`) is the child entity.\n   *   - The **to** (`w`) is the parent entity.\n   */\n  type: 'association' | 'property' | 'parent'\n}\n\nexport type DomainGraphNodeType = DomainNamespace | DomainModel | DomainEntity | DomainProperty | DomainAssociation\n\n/**\n * An interface that describes the data domain dependency.\n */\nexport interface ForeignDomainDependency {\n  /**\n   * The system registered key of the foreign domain.\n   */\n  key: string\n  /**\n   * The version of the foreign domain used in this domain.\n   */\n  version: string\n}\n\nexport interface AssociationTarget {\n  /**\n   * The key of the target entity.\n   */\n  key: string\n  /**\n   * The key of the target data domain.\n   * This is only set when the target is in a different data domain.\n   */\n  domain?: string\n}\n\n/**\n * Describes the default value set on a property schema.\n */\nexport interface SchemaDefaultValue {\n  /**\n   * The type of the default value.\n   *\n   * - `literal` The `value` should be used as-is.\n   * - `function` The value represents the name of the function to be used.\n   */\n  type: 'literal' | 'function'\n  /**\n   * The actual value type depends on the `type`.\n   * It is always a string and it has to be casted to the property's data type.\n   */\n  value: string\n}\n\n/**\n * A general schema definition for a property.\n * This is propagated to all bindings (when they support these properties).\n */\nexport interface PropertySchema {\n  /**\n   * The minimum value of the property.\n   *\n   * By default it is inclusive value. Use the `exclusiveMinimum` property to make it exclusive.\n   *\n   * Used with:\n   * - string\n   * - number\n   * - date\n   * - time\n   * - datetime\n   */\n  minimum?: number\n  /**\n   * The maximum value of the property.\n   *\n   * By default it is inclusive value. Use the `exclusiveMaximum` property to make it exclusive.\n   *\n   * Used with:\n   * - string\n   * - number\n   * - date\n   * - time\n   * - datetime\n   */\n  maximum?: number\n  /**\n   * When set, the minimum value is exclusive.\n   *\n   * - When `false`: value ≥ minimum.\n   * - When `true`: value > minimum.\n   */\n  exclusiveMinimum?: boolean\n  /**\n   * When set, the exclusiveMaximum value is exclusive.\n   *\n   * - When `false`: value ≤ maximum.\n   * - When `true`: value < minimum.\n   */\n  exclusiveMaximum?: boolean\n  /**\n   * The multiplier value for a number scalar.\n   *\n   * Examples:\n   * - if `1` then every integer is allowed\n   * - if `2` than every even number is allowed\n   * - if `0.5` than every number dividable by `0.5` is allowed\n   */\n  multipleOf?: number\n  /**\n   * The enum values for the property.\n   * They are always encoded as strings. The actual type is defined in the `dataType` property.\n   */\n  enum?: string[]\n  /**\n   * The default value for the property.\n   * This is always encoded as a string. The actual type is defined in the `dataType` property.\n   */\n  defaultValue?: SchemaDefaultValue\n  /**\n   * The example values for the property.\n   * They are always encoded as strings. The actual type is defined in the `dataType` property.\n   */\n  examples?: string[]\n}\n\n/**\n * The shortcut type for the data domain graph.\n */\nexport type DataDomainGraph = Graph<unknown, DomainGraphNodeType, DomainGraphEdge>\n/**\n * The serialized version of the data domain graph.\n */\nexport type SerializedGraph = GraphJson<unknown, object, DomainGraphEdge>\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/modeling/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { GraphJson } from '@api-client/graph/graph/types.js'\nimport type { Graph } from '@api-client/graph/graph/Graph.js'\nimport type { DomainAssociation } from './DomainAssociation.js'\nimport type { DomainEntity } from './DomainEntity.js'\nimport type { DomainModel } from './DomainModel.js'\nimport type { DomainNamespace } from './DomainNamespace.js'\nimport type { DomainProperty } from './DomainProperty.js'\n\nexport interface DataDomainRemoveOptions {\n  /**\n   * When true, the object will be forcibly removed.\n   * The resolution defined in the `ImpactResolution` class will be applied.\n   *\n   * For example, when removing an entity that is a parent to another entity, it will\n   * removed itself as a parent from the child entity.\n   *\n   * Note, this option should only be used when the DomainImpactAnalysis has been performed\n   * and the user was informed of the impact.\n   */\n  force?: boolean\n}\n\nexport interface AssociationAddOptions {\n  /**\n   * When set, it is the the association target's origin data domain.\n   * The key of the target data domain where this target entity is defined.\n   * Only used when `key` is specified.\n   */\n  domain?: string\n  /**\n   * The key of the association target, if known.\n   * If the target of the association is not specified, and the association has no other targets,\n   * the association is ignored in the namespace while processing.\n   */\n  key?: string\n}\n\nexport interface DomainGraphEdge {\n  /**\n   * Indicates that the edge is to or from a foreign domain.\n   */\n  foreign?: boolean\n  /**\n   * The key of the foreign domain. Always set with the `foreign` property.\n   */\n  domain?: string\n  /**\n   * The type of the edge.\n   * - `association` The edge is to an association object.\n   *   - When coming **from** an entiry (the `v` property), that entity owns the association.\n   *   - When coming **to** an entity (the `w` property), that entity is the target of the association.\n   *     An association can have multiple targets.\n   * - `property` The edge is to a property object. Can only be created between an entity and a property.\n   *   - The **from** (`v`) is the entity.\n   *   - The **to** (`w`) is the property.\n   * - `parent` The edge is to a parent object.\n   *   - The **from** (`v`) is the child entity.\n   *   - The **to** (`w`) is the parent entity.\n   */\n  type: 'association' | 'property' | 'parent'\n}\n\nexport type DomainGraphNodeType = DomainNamespace | DomainModel | DomainEntity | DomainProperty | DomainAssociation\n\n/**\n * An interface that describes the data domain dependency.\n */\nexport interface ForeignDomainDependency {\n  /**\n   * The system registered key of the foreign domain.\n   */\n  key: string\n  /**\n   * The version of the foreign domain used in this domain.\n   */\n  version: string\n}\n\nexport interface AssociationTarget {\n  /**\n   * The key of the target entity.\n   */\n  key: string\n  /**\n   * The key of the target data domain.\n   * This is only set when the target is in a different data domain.\n   */\n  domain?: string\n}\n\n/**\n * Describes the default value set on a property schema.\n */\nexport interface SchemaDefaultValue {\n  /**\n   * The type of the default value.\n   *\n   * - `literal` The `value` should be used as-is.\n   * - `function` The value represents the name of the function to be used.\n   */\n  type: 'literal' | 'function'\n  /**\n   * The actual value type depends on the `type`.\n   * It is always a string and it has to be casted to the property's data type.\n   */\n  value: string\n}\n\n/**\n * A general schema definition for a property.\n * This is propagated to all bindings (when they support these properties).\n */\nexport interface PropertySchema {\n  /**\n   * The minimum value of the property.\n   *\n   * By default it is inclusive value. Use the `exclusiveMinimum` property to make it exclusive.\n   *\n   * Used with:\n   * - string\n   * - number\n   * - date\n   * - time\n   * - datetime\n   */\n  minimum?: number\n  /**\n   * The maximum value of the property.\n   *\n   * By default it is inclusive value. Use the `exclusiveMaximum` property to make it exclusive.\n   *\n   * Used with:\n   * - string\n   * - number\n   * - date\n   * - time\n   * - datetime\n   */\n  maximum?: number\n  /**\n   * When set, the minimum value is exclusive.\n   *\n   * - When `false`: value ≥ minimum.\n   * - When `true`: value > minimum.\n   */\n  exclusiveMinimum?: boolean\n  /**\n   * When set, the exclusiveMaximum value is exclusive.\n   *\n   * - When `false`: value ≤ maximum.\n   * - When `true`: value < minimum.\n   */\n  exclusiveMaximum?: boolean\n  /**\n   * The multiplier value for a number scalar.\n   *\n   * Examples:\n   * - if `1` then every integer is allowed\n   * - if `2` than every even number is allowed\n   * - if `0.5` than every number dividable by `0.5` is allowed\n   */\n  multipleOf?: number\n  /**\n   * The enum values for the property.\n   * They are always encoded as strings. The actual type is defined in the `dataType` property.\n   */\n  enum?: string[]\n  /**\n   * The default value for the property.\n   * This is always encoded as a string. The actual type is defined in the `dataType` property.\n   */\n  defaultValue?: SchemaDefaultValue\n  /**\n   * The example values for the property.\n   * They are always encoded as strings. The actual type is defined in the `dataType` property.\n   */\n  examples?: string[]\n}\n\n/**\n * The shortcut type for the data domain graph.\n */\nexport type DataDomainGraph = Graph<unknown, DomainGraphNodeType, DomainGraphEdge>\n/**\n * The serialized version of the data domain graph.\n */\nexport type SerializedGraph = GraphJson<unknown, object, DomainGraphEdge>\n\n/**\n * Represents a standardized, machine-readable error response body\n * as defined by RFC 7807 for HTTP APIs.\n */\nexport interface ProblemDetails {\n  /**\n   * A URI that identifies the specific problem type. Should resolve to human-readable docs.\n   * e.g., \"https://docs.apinow.app/errors/validation-failed\"\n   */\n  type: string\n\n  /**\n   * A short, human-readable summary of the problem type.\n   * e.g., \"Validation Error\"\n   */\n  title: string\n\n  /**\n   * The HTTP status code generated by the origin server for this problem.\n   */\n  status?: number\n\n  /**\n   * A human-readable explanation specific to this occurrence of the problem.\n   */\n  detail?: string\n\n  /**\n   * A URI that identifies the specific occurrence of the problem.\n   * Can be the API request path that caused the error.\n   */\n  instance: string\n}\n\n/**\n * The set of supported filter operators for the List action.\n * These are used in query parameters, e.g., ?price[gte]=100\n *\n * - eq: Equal\n * - nq: Not Equal\n * - lt: Less Than\n * - lte: Less Than or Equal\n * - gt: Greater Than\n * - gte: Greater Than or Equal\n * - ex: Checks if the field exists\n * - re: Regular expression match\n * - bf: Date before a specific value\n * - af: Date after a specific value\n * - cn: String contains substring / Array contains element\n * - st: String starts with\n * - end: String ends with\n * - in: Value is one of the elements in the provided array\n * - nin: Value is not one of the elements in the provided array\n */\nexport type ResourceFilterOperator =\n  | 'eq' // Equal\n  | 'nq' // Not equal\n  | 'lt' // Less than\n  | 'lte' // Less than or equal\n  | 'gt' // Greater than\n  | 'gte' // Greater than or equal\n  | 'ex' // Checks if the field exists\n  | 're' // Regular expression match\n  | 'bf' // Date before a specific value\n  | 'af' // Date after a specific value\n  | 'cn' // String contains substring / Array contains element\n  | 'st' // String starts with\n  | 'end' // String ends with\n  | 'in' // Value is one of the elements in the provided array\n  | 'nin' // Value is not one of the elements in the provided array\n\n/**\n * The session transport configuration interface.\n * This defines the properties that are common to all session transports.\n */\ninterface SessionTransport {\n  /**\n   * Whether the session transport is enabled.\n   */\n  enabled: boolean\n  /**\n   * The kind of session transport. Each interface defines its own kind.\n   */\n  kind: string\n}\n\n/**\n * Configuration for cookie-based session transport.\n */\nexport interface CookieConfiguration extends SessionTransport {\n  kind: 'cookie'\n  /**\n   * The lifetime of the cookie session.\n   * This is a string representing the duration, e.g., \"7d\" for 7 days or \"24h\" for 24 hours.\n   *\n   * @default \"7d\"\n   */\n  lifetime: string\n  /**\n   * Whether the cookie can only be accessed by the server.\n   * This is a security feature to prevent client-side scripts from accessing the cookie.\n   * If set to false, the cookie can be accessed by client-side scripts.\n   * @default true\n   */\n  httpOnly: boolean // Defaults to true\n  /**\n   * Whether the cookie should only be sent over secure connections (HTTPS).\n   * This is a security feature to prevent the cookie from being sent over unencrypted connections.\n   * @default true\n   */\n  secure: boolean\n  /**\n   * The SameSite attribute of the cookie.\n   * This attribute controls whether the cookie is sent with cross-site requests.\n   * - 'none' means the cookie is sent with cross-site requests.\n   * - 'lax' means the cookie is sent with top-level navigations and will be sent along with GET\n   *   requests initiated by third-party websites.\n   * @default 'none'\n   */\n  sameSite: 'none' | 'lax'\n  /**\n   * The name of the cookie.\n   * This is the key under which the session data will be stored in the cookie.\n   * @default 'as' - 'as' stands for \"api session\"\n   */\n  name: string\n}\n\n/**\n * Configuration for JWT-based session transport.\n */\nexport interface JwtConfiguration extends SessionTransport {\n  kind: 'jwt'\n  /**\n   * The lifetime of the JWT token.\n   * This is a string representing the duration, e.g., \"7d\" for 7 days or \"15m\" for 15 minutes.\n   *\n   * @default \"7d\"\n   */\n  lifetime: string\n}\n\nexport interface SessionConfiguration {\n  /**\n   * The secret used to sign the JWT and cookies. Should be handled securely.\n   * Not visible in the UI after being set.\n   */\n  secret: string\n  /**\n   * The properties from the `User` entity to be encoded into the session payload (JWT/cookie).\n   * These properties become available in the `request.auth` object at runtime.\n   */\n  properties: string[]\n  /**\n   * The cookie-based session transport configuration.\n   */\n  cookie?: CookieConfiguration\n\n  /**\n   * The JWT-based session transport configuration.\n   */\n  jwt?: JwtConfiguration\n}\n\n/**\n * Defines the authorization strategy for the API.\n * It is a base interface that can be extended for different strategies.\n * For MVP, we will start with Roles-Based Access Control (RBAC).\n */\nexport interface AuthorizationConfiguration {\n  /**\n   * The authorization strategy. For MVP, we will start with RBAC.\n   * Post-MVP will include Permission-Based Access Control (PBAC).\n   * The strategy determines how users are granted access to resources.\n   *\n   * - RBAC (Roles-Based Access Control): Users are assigned roles, and permissions are granted to those roles.\n   * - PBAC (Permission-Based Access Control): Users are granted permissions directly, allowing for more\n   *   granular control.\n   */\n  strategy: string\n}\n\nexport interface RolesBasedAccessControl extends AuthorizationConfiguration {\n  strategy: 'RBAC'\n  /**\n   * The property within the designated \"User\" entity that defines the user's role.\n   * This field is used in access rules to grant permissions.\n   *\n   * This property must be marked with the \"Role\" data semantic in the Data Modeler.\n   * It is required to publish the API.\n   */\n  roleKey: string\n}\n\n/**\n * Configures the strategy for authenticating end-users.\n * An API can only support one authentication strategy at a time.\n * This is a base interface that can be extended for different strategies.\n */\nexport interface AuthenticationConfiguration {\n  /**\n   * The authentication method. For MVP, this is focused on username/password.\n   * This can be extended in the future to include 'SSO'.\n   */\n  strategy: string\n}\n\n/**\n * Configuration for username/password authentication.\n * This is the primary authentication method for the API (MVP).\n */\nexport interface UsernamePasswordConfiguration extends AuthenticationConfiguration {\n  strategy: 'UsernamePassword'\n  /**\n   * The specific property within the User entity that holds the password.\n   * This property must be marked with the \"Password\" data semantic in the Data Modeler.\n   *\n   * This property is required to publish the API.\n   */\n  passwordKey?: string\n}\n\n/**\n * Represents a Data Entity from the Data Domain that the API will expose and operate upon.\n */\nexport interface ExposedEntity {\n  /**\n   * The key of the Data Entity from the Data Domain.\n   */\n  key: string\n\n  /**\n   * Optional configuration for resource-wide rate limiting and throttling.\n   * Defines rules to protect the resource from overuse.\n   */\n  rateLimiting?: RateLimitingConfiguration\n  /**\n   * Access control rules defining who can perform actions on this resource or collection.\n   * It override the top-level access rules defined in the API model.\n   */\n  accessRule?: AccessRule[]\n\n  /**\n   * The collection of API actions (e.g., List, Read, Create) enabled for this entity.\n   */\n  actions: ApiAction[]\n}\n\n/**\n * Represents a specific, configurable API operation applied to a Data Entity.\n * Corresponds to common RESTful interactions.\n */\nexport type ApiAction = ListAction | ReadAction | CreateAction | UpdateAction | DeleteAction | SearchAction\n\n/**\n * A base interface for common properties across all actions.\n */\ninterface Action {\n  /**\n   * The specific kind of action (e.g., 'List', 'Read', etc.)\n   */\n  kind: string\n  /**\n   * Access control rules defining who can perform this action. It is only applied if the\n   * authorization strategy is set to 'RBAC'.\n   * If no rules grant access, it's denied by default making it essentially private.\n   *\n   * Note, the API can defined top level access rules that apply to all actions. If this property is set,\n   * it overrides the top level access rules for this specific action.\n   *\n   * It is an ordered list, meaning the first rule that matches the user will be applied.\n   * If multiple rules match, the first one in the list takes precedence.\n   * If no rules match, the action is denied.\n   */\n  accessRule?: AccessRule[]\n  /**\n   * Optional configuration for action-wide rate limiting and throttling.\n   * Defines rules to protect the action from overuse.\n   */\n  rateLimiting?: RateLimitingConfiguration\n}\n\n/**\n * Represents a pagination strategy for API actions that return collections of resources.\n * This is a base interface that can be extended for different pagination strategies.\n */\nexport interface PaginationStrategy {\n  /**\n   * The kind of pagination strategy. This is used to identify the specific pagination method.\n   * For example, 'cursor' for cursor-based pagination or 'offset' for offset-based pagination.\n   */\n  kind: string\n  /**\n   * The default page size for the pagination strategy.\n   * This is the number of items returned per page when no specific page size is requested.\n   */\n  pageSize?: number\n}\n\n/**\n * Represents the cursor-based pagination strategy.\n */\nexport interface CursorPaginationStrategy extends PaginationStrategy {\n  kind: 'cursor'\n}\n\n/**\n * Represents the offset-based pagination strategy.\n */\nexport interface OffsetPaginationStrategy extends PaginationStrategy {\n  kind: 'offset'\n}\n\n/**\n * Enables retrieving a collection of resources.\n * Endpoint: GET /[entity-collection-name]\n */\nexport interface ListAction extends Action {\n  kind: 'list'\n  /**\n   * The pagination strategy used for this action.\n   * This defines how the results are paginated when retrieving a collection of resources.\n   * It can be either 'cursor' or 'offset'.\n   */\n  pagination: PaginationStrategy\n  /**\n   * Fields from the entity that can be used for filtering.\n   * Must be marked as \"indexable\" in the Data Model.\n   */\n  filterableFields: string[]\n  /**\n   * Fields from the entity that can be used for sorting.\n   */\n  sortableFields: string[]\n}\n\n/**\n * Enables retrieving a single resource by its ID.\n * Endpoint: GET /[entity-collection-name]/{id}\n */\nexport interface ReadAction extends Action {\n  kind: 'read'\n  // Association handling (Link IDs vs. Embed) is defined on the\n  // data association itself in the Data Modeler.\n}\n\n/**\n * Enables adding a new resource to a collection.\n * Endpoint: POST /[entity-collection-name]\n */\nexport interface CreateAction extends Action {\n  kind: 'create'\n}\n\n/**\n * Enables modifying an existing resource.\n * Endpoints: PUT or PATCH /[entity-collection-name]/{id}\n */\nexport interface UpdateAction extends Action {\n  kind: 'update'\n  /**\n   * The allowed HTTP methods for updates. Default: PATCH only.\n   *\n   * These two methods represent the two common ways to update a resource:\n   * - PUT: Replaces the entire resource with the provided data.\n   * - PATCH: Applies a partial update to the resource, allowing for specific fields to be modified.\n   */\n  allowedMethods: ('PUT' | 'PATCH')[]\n}\n\n/**\n * Enables removing an existing resource.\n * Endpoint: DELETE /[entity-collection-name]/{id}\n */\nexport interface DeleteAction extends Action {\n  kind: 'delete'\n  /**\n   * The strategy for deletion. Default: Soft Delete.\n   *\n   * @default 'soft'\n   */\n  strategy?: 'soft' | 'hard'\n}\n\n/**\n * Enables keyword-based search across specified fields.\n * Endpoint: GET /[entity-collection-name]/search\n */\nexport interface SearchAction extends Action {\n  kind: 'search'\n  /**\n   * The fields within the entity to be included in the search scope.\n   * Must be \"indexable\" and typically text-based.\n   */\n  fields: string[]\n}\n\n/**\n * Defines the access control policy for a specific API action.\n * Based on the predefined rule types for session-based authentication.\n */\nexport type AccessRule =\n  | AllowPublicAccessRule\n  | AllowAuthenticatedAccessRule\n  | MatchResourceOwnerAccessRule\n  | MatchUserRoleAccessRule\n  | MatchUserPropertyAccessRule\n  | MatchEmailDomainAccessRule\n\nexport interface BaseAccessRule {\n  /**\n   * The unique identifier for the access rule.\n   * This is used to reference the rule in the API configuration.\n   */\n  type: string\n}\n\n/**\n * The action is allowed for all users, including unauthenticated ones.\n * This is typically used for public APIs or resources that do not require authentication.\n * It is the most permissive rule and should be used with caution.\n */\nexport interface AllowPublicAccessRule extends BaseAccessRule {\n  type: 'public'\n}\n/**\n * The action is allowed for any authenticated user.\n * This rule does not impose any additional restrictions based on user properties or resource ownership.\n * It is used for resources that should be accessible to all logged-in users.\n */\nexport interface AllowAuthenticatedAccessRule extends BaseAccessRule {\n  type: 'authenticated'\n}\n/**\n * The action is allowed if the authenticated user's ID matches a specific property on the resource.\n * This is typically used to restrict access to resources owned by the user.\n * For example, a user can only access their own profile or documents.\n */\nexport interface MatchResourceOwnerAccessRule extends BaseAccessRule {\n  type: 'resourceOwner'\n  /**\n   * The property on the resource that should match the authenticated user's ID.\n   * This is typically the ID of the user who owns the resource.\n   *\n   * The domain model should annotate this property with the \"ResourceOwnerIdentifier\" semantic\n   * to indicate that it is used for ownership checks.\n   */\n  property: string\n}\n\n/**\n * The action is allowed if the authenticated user has a specific role.\n * This is used to enforce role-based access control (RBAC).\n * For example, only users with the \"admin\" role can perform certain actions.\n */\nexport interface MatchUserRoleAccessRule extends BaseAccessRule {\n  type: 'matchUserRole'\n  /**\n   * The role that the authenticated user must have to access the resource.\n   * This is typically a property on the user entity that defines their role.\n   *\n   * The domain model should annotate this property with the \"UserRole\" semantic\n   * to indicate that it is used for role-based access control.\n   */\n  role: string\n}\n/**\n * The action is allowed if a specific property on the authenticated user matches an expected value.\n * This is used to enforce other user-specific restrictions.\n */\nexport interface MatchUserPropertyAccessRule extends BaseAccessRule {\n  type: 'matchUserProperty'\n  /**\n   * The property on the authenticated user that should match the expected value.\n   */\n  property: string\n  /**\n   * The expected value for the user property.\n   */\n  value: string\n}\n/**\n * The action is allowed if the authenticated user's email domain matches a specific domain.\n * This is used to restrict access based on the user's email address.\n * For example, only users with an email address from \"mycompany.com\" can access certain resources.\n */\nexport interface MatchEmailDomainAccessRule extends BaseAccessRule {\n  type: 'matchEmailDomain'\n  /**\n   * The email domain that the authenticated user's email must match.\n   */\n  domain: string\n}\n\n/**\n * Defines the rate limiting and throttling policies for the entire API.\n */\nexport interface RateLimitingConfiguration {\n  /**\n   * An ordered list of rules. The first rule that matches an incoming\n   * request will be applied.\n   */\n  rules: RateLimitRule[]\n}\n\n/**\n * Represents a single rate limiting rule that applies to a specific\n * type of client, using a token bucket algorithm.\n */\nexport interface RateLimitRule {\n  /**\n   * A human-readable description of what this rule is for.\n   * e.g., \"Limit anonymous users to 60 requests per hour.\"\n   */\n  description?: string\n\n  /**\n   * Defines how to group requests for rate limiting. This determines\n   * who the limit applies to.\n   *\n   * - 'ip': Keys on the client's IP address. Best for anonymous traffic.\n   * - 'userId': Keys on the authenticated user's ID. Best for logged-in users.\n   * - 'role': Applies a shared limit to all users of a specific role.\n   */\n  key: { type: 'ip' } | { type: 'userId' } | { type: 'role'; value: string }\n\n  /**\n   * The number of requests allowed over the defined interval.\n   * This is the rate at which tokens are added to the bucket.\n   */\n  rate: number\n\n  /**\n   * The time interval for the rate.\n   */\n  interval: 'second' | 'minute' | 'hour' | 'day'\n\n  /**\n   * The maximum number of requests that can be made in a burst.\n   * This represents the \"bucket size.\" A larger burst allows for\n   * more requests to be made in a short period before throttling begins.\n   */\n  burst: number\n}\n"]}

package/build/src/models/kinds.d.ts

@@ -20,4 +20,7 @@ export declare const DataCatalogKind = "Core#DataCatalog";
 export declare const DataCatalogVersionKind = "Core#DataCatalogVersion";
 export declare const OrganizationKind = "Core#Organization";
 export declare const InvitationKind = "Core#Invitation";
+export declare const ApiModelKind = "Core#ApiModel";
+export declare const ApiFileKind = "Core#ApiFile";
+export declare const GroupKind = "Core#Group";
 //# sourceMappingURL=kinds.d.ts.map

package/build/src/models/kinds.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"kinds.d.ts","sourceRoot":"","sources":["../../../src/models/kinds.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,iBAAiB,uBAAuB,CAAA;AACrD,eAAO,MAAM,YAAY,sBAAsB,CAAA;AAC/C,eAAO,MAAM,gBAAgB,sBAAsB,CAAA;AACnD,eAAO,MAAM,mBAAmB,yBAAyB,CAAA;AACzD,eAAO,MAAM,UAAU,gBAAgB,CAAA;AACvC,eAAO,MAAM,WAAW,iBAAiB,CAAA;AACzC,eAAO,MAAM,SAAS,eAAe,CAAA;AACrC,eAAO,MAAM,YAAY,kBAAkB,CAAA;AAC3C,eAAO,MAAM,YAAY,kBAAkB,CAAA;AAC3C,eAAO,MAAM,wBAAwB,8BAA8B,CAAA;AACnE,eAAO,MAAM,QAAQ,cAAc,CAAA;AACnC,eAAO,MAAM,cAAc,oBAAoB,CAAA;AAC/C,eAAO,MAAM,cAAc,gBAAgB,CAAA;AAC3C,eAAO,MAAM,mBAAmB,qBAAqB,CAAA;AACrD,eAAO,MAAM,eAAe,iBAAiB,CAAA;AAC7C,eAAO,MAAM,gBAAgB,kBAAkB,CAAA;AAC/C,eAAO,MAAM,qBAAqB,uBAAuB,CAAA;AACzD,eAAO,MAAM,kBAAkB,oBAAoB,CAAA;AACnD,eAAO,MAAM,eAAe,qBAAqB,CAAA;AACjD,eAAO,MAAM,sBAAsB,4BAA4B,CAAA;AAC/D,eAAO,MAAM,gBAAgB,sBAAsB,CAAA;AACnD,eAAO,MAAM,cAAc,oBAAoB,CAAA"}
+{"version":3,"file":"kinds.d.ts","sourceRoot":"","sources":["../../../src/models/kinds.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,iBAAiB,uBAAuB,CAAA;AACrD,eAAO,MAAM,YAAY,sBAAsB,CAAA;AAC/C,eAAO,MAAM,gBAAgB,sBAAsB,CAAA;AACnD,eAAO,MAAM,mBAAmB,yBAAyB,CAAA;AACzD,eAAO,MAAM,UAAU,gBAAgB,CAAA;AACvC,eAAO,MAAM,WAAW,iBAAiB,CAAA;AACzC,eAAO,MAAM,SAAS,eAAe,CAAA;AACrC,eAAO,MAAM,YAAY,kBAAkB,CAAA;AAC3C,eAAO,MAAM,YAAY,kBAAkB,CAAA;AAC3C,eAAO,MAAM,wBAAwB,8BAA8B,CAAA;AACnE,eAAO,MAAM,QAAQ,cAAc,CAAA;AACnC,eAAO,MAAM,cAAc,oBAAoB,CAAA;AAC/C,eAAO,MAAM,cAAc,gBAAgB,CAAA;AAC3C,eAAO,MAAM,mBAAmB,qBAAqB,CAAA;AACrD,eAAO,MAAM,eAAe,iBAAiB,CAAA;AAC7C,eAAO,MAAM,gBAAgB,kBAAkB,CAAA;AAC/C,eAAO,MAAM,qBAAqB,uBAAuB,CAAA;AACzD,eAAO,MAAM,kBAAkB,oBAAoB,CAAA;AACnD,eAAO,MAAM,eAAe,qBAAqB,CAAA;AACjD,eAAO,MAAM,sBAAsB,4BAA4B,CAAA;AAC/D,eAAO,MAAM,gBAAgB,sBAAsB,CAAA;AACnD,eAAO,MAAM,cAAc,oBAAoB,CAAA;AAC/C,eAAO,MAAM,YAAY,kBAAkB,CAAA;AAC3C,eAAO,MAAM,WAAW,iBAAiB,CAAA;AACzC,eAAO,MAAM,SAAS,eAAe,CAAA"}

package/build/src/models/kinds.js

@@ -20,4 +20,7 @@ export const DataCatalogKind = 'Core#DataCatalog';
 export const DataCatalogVersionKind = 'Core#DataCatalogVersion';
 export const OrganizationKind = 'Core#Organization';
 export const InvitationKind = 'Core#Invitation';
+export const ApiModelKind = 'Core#ApiModel';
+export const ApiFileKind = 'Core#ApiFile';
+export const GroupKind = 'Core#Group';
 //# sourceMappingURL=kinds.js.map

package/build/src/models/kinds.js.map

@@ -1 +1 @@
-{"version":3,"file":"kinds.js","sourceRoot":"","sources":["../../../src/models/kinds.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,iBAAiB,GAAG,oBAAoB,CAAA;AACrD,MAAM,CAAC,MAAM,YAAY,GAAG,mBAAmB,CAAA;AAC/C,MAAM,CAAC,MAAM,gBAAgB,GAAG,mBAAmB,CAAA;AACnD,MAAM,CAAC,MAAM,mBAAmB,GAAG,sBAAsB,CAAA;AACzD,MAAM,CAAC,MAAM,UAAU,GAAG,aAAa,CAAA;AACvC,MAAM,CAAC,MAAM,WAAW,GAAG,cAAc,CAAA;AACzC,MAAM,CAAC,MAAM,SAAS,GAAG,YAAY,CAAA;AACrC,MAAM,CAAC,MAAM,YAAY,GAAG,eAAe,CAAA;AAC3C,MAAM,CAAC,MAAM,YAAY,GAAG,eAAe,CAAA;AAC3C,MAAM,CAAC,MAAM,wBAAwB,GAAG,2BAA2B,CAAA;AACnE,MAAM,CAAC,MAAM,QAAQ,GAAG,WAAW,CAAA;AACnC,MAAM,CAAC,MAAM,cAAc,GAAG,iBAAiB,CAAA;AAC/C,MAAM,CAAC,MAAM,cAAc,GAAG,aAAa,CAAA;AAC3C,MAAM,CAAC,MAAM,mBAAmB,GAAG,kBAAkB,CAAA;AACrD,MAAM,CAAC,MAAM,eAAe,GAAG,cAAc,CAAA;AAC7C,MAAM,CAAC,MAAM,gBAAgB,GAAG,eAAe,CAAA;AAC/C,MAAM,CAAC,MAAM,qBAAqB,GAAG,oBAAoB,CAAA;AACzD,MAAM,CAAC,MAAM,kBAAkB,GAAG,iBAAiB,CAAA;AACnD,MAAM,CAAC,MAAM,eAAe,GAAG,kBAAkB,CAAA;AACjD,MAAM,CAAC,MAAM,sBAAsB,GAAG,yBAAyB,CAAA;AAC/D,MAAM,CAAC,MAAM,gBAAgB,GAAG,mBAAmB,CAAA;AACnD,MAAM,CAAC,MAAM,cAAc,GAAG,iBAAiB,CAAA","sourcesContent":["export const ProjectFolderKind = 'Core#ProjectFolder'\nexport const ResponseKind = 'Core#HttpResponse'\nexport const HttpResponseKind = 'Core#HttpResponse'\nexport const CertificateFileKind = 'Core#CertificateFile'\nexport const FolderKind = 'Core#Folder'\nexport const ProjectKind = 'Core#Project'\nexport const ThingKind = 'Core#Thing'\nexport const DeletionKind = 'Core#Deletion'\nexport const RevisionKind = 'Core#Revision'\nexport const UnresolvedDependencyKind = 'Core#UnresolvedDependency'\nexport const UserKind = 'Core#User'\nexport const DomainFileKind = 'Data#DomainFile'\nexport const DataDomainKind = 'Data#Domain'\nexport const DomainNamespaceKind = 'Domain#Namespace'\nexport const DomainModelKind = 'Domain#Model'\nexport const DomainEntityKind = 'Domain#Entity'\nexport const DomainAssociationKind = 'Domain#Association'\nexport const DomainPropertyKind = 'Domain#Property'\nexport const DataCatalogKind = 'Core#DataCatalog'\nexport const DataCatalogVersionKind = 'Core#DataCatalogVersion'\nexport const OrganizationKind = 'Core#Organization'\nexport const InvitationKind = 'Core#Invitation'\n"]}
+{"version":3,"file":"kinds.js","sourceRoot":"","sources":["../../../src/models/kinds.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,iBAAiB,GAAG,oBAAoB,CAAA;AACrD,MAAM,CAAC,MAAM,YAAY,GAAG,mBAAmB,CAAA;AAC/C,MAAM,CAAC,MAAM,gBAAgB,GAAG,mBAAmB,CAAA;AACnD,MAAM,CAAC,MAAM,mBAAmB,GAAG,sBAAsB,CAAA;AACzD,MAAM,CAAC,MAAM,UAAU,GAAG,aAAa,CAAA;AACvC,MAAM,CAAC,MAAM,WAAW,GAAG,cAAc,CAAA;AACzC,MAAM,CAAC,MAAM,SAAS,GAAG,YAAY,CAAA;AACrC,MAAM,CAAC,MAAM,YAAY,GAAG,eAAe,CAAA;AAC3C,MAAM,CAAC,MAAM,YAAY,GAAG,eAAe,CAAA;AAC3C,MAAM,CAAC,MAAM,wBAAwB,GAAG,2BAA2B,CAAA;AACnE,MAAM,CAAC,MAAM,QAAQ,GAAG,WAAW,CAAA;AACnC,MAAM,CAAC,MAAM,cAAc,GAAG,iBAAiB,CAAA;AAC/C,MAAM,CAAC,MAAM,cAAc,GAAG,aAAa,CAAA;AAC3C,MAAM,CAAC,MAAM,mBAAmB,GAAG,kBAAkB,CAAA;AACrD,MAAM,CAAC,MAAM,eAAe,GAAG,cAAc,CAAA;AAC7C,MAAM,CAAC,MAAM,gBAAgB,GAAG,eAAe,CAAA;AAC/C,MAAM,CAAC,MAAM,qBAAqB,GAAG,oBAAoB,CAAA;AACzD,MAAM,CAAC,MAAM,kBAAkB,GAAG,iBAAiB,CAAA;AACnD,MAAM,CAAC,MAAM,eAAe,GAAG,kBAAkB,CAAA;AACjD,MAAM,CAAC,MAAM,sBAAsB,GAAG,yBAAyB,CAAA;AAC/D,MAAM,CAAC,MAAM,gBAAgB,GAAG,mBAAmB,CAAA;AACnD,MAAM,CAAC,MAAM,cAAc,GAAG,iBAAiB,CAAA;AAC/C,MAAM,CAAC,MAAM,YAAY,GAAG,eAAe,CAAA;AAC3C,MAAM,CAAC,MAAM,WAAW,GAAG,cAAc,CAAA;AACzC,MAAM,CAAC,MAAM,SAAS,GAAG,YAAY,CAAA","sourcesContent":["export const ProjectFolderKind = 'Core#ProjectFolder'\nexport const ResponseKind = 'Core#HttpResponse'\nexport const HttpResponseKind = 'Core#HttpResponse'\nexport const CertificateFileKind = 'Core#CertificateFile'\nexport const FolderKind = 'Core#Folder'\nexport const ProjectKind = 'Core#Project'\nexport const ThingKind = 'Core#Thing'\nexport const DeletionKind = 'Core#Deletion'\nexport const RevisionKind = 'Core#Revision'\nexport const UnresolvedDependencyKind = 'Core#UnresolvedDependency'\nexport const UserKind = 'Core#User'\nexport const DomainFileKind = 'Data#DomainFile'\nexport const DataDomainKind = 'Data#Domain'\nexport const DomainNamespaceKind = 'Domain#Namespace'\nexport const DomainModelKind = 'Domain#Model'\nexport const DomainEntityKind = 'Domain#Entity'\nexport const DomainAssociationKind = 'Domain#Association'\nexport const DomainPropertyKind = 'Domain#Property'\nexport const DataCatalogKind = 'Core#DataCatalog'\nexport const DataCatalogVersionKind = 'Core#DataCatalogVersion'\nexport const OrganizationKind = 'Core#Organization'\nexport const InvitationKind = 'Core#Invitation'\nexport const ApiModelKind = 'Core#ApiModel'\nexport const ApiFileKind = 'Core#ApiFile'\nexport const GroupKind = 'Core#Group'\n"]}

package/build/src/models/store/File.d.ts

@@ -158,6 +158,18 @@ export declare class StoredFile {
      */
     get shortcutTarget(): string | undefined;
     set shortcutTarget(value: string | undefined);
+    /**
+     * Creates a file schema object with the given properties.
+     * The `key` is generated if not set.
+     *
+     * @param input The input to create the file schema.
+     * @returns The file schema object.
+     */
+    static createSchema(input?: Partial<IStoredFile>): IStoredFile;
+    constructor(state: IStoredFile);
+    /**
+     * @deprecated Use `createSchema()` and setup values in the constructor instead.
+     */
     new(init: IStoredFile): this;
     toJSON(): IStoredFile;
     /**
@@ -251,13 +263,18 @@ export declare class File extends StoredFile {
      * opaque value.
      */
     get permissions(): readonly IPermission[];
+    static createSchema(input?: Partial<IFile>): IFile;
+    constructor(state?: Partial<IFile>);
+    /**
+     * @deprecated Use `createSchema()` and setup values in the constructor instead.
+     */
     new(init: IFile): this;
     toJSON(): IFile;
     /**
      * @param name The name to set.
-     * @param owner The user id that is the owner of the file.
+     * @param kind The kind of the file to create.
      */
-    static fromName(name: string, kind?: string): File;
+    static fromName(name: string, kind: string): File;
     shortcutTo(fileId: string): this;
     /**
      * Updates the "lastModified" value.