@cycomdatasystems/mackinac-sdk 5.0.0 → 5.2.1

package/dist/generated/models/userDto.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * Do not edit manually.
+ * Mackinac API
+ * Mackinac API - feature parity with Golden Gate.
+
+**Custom Forms conventions**
+
+- UUIDs are lowercase hyphenated strings.
+- Pagination is cursor-based: `?cursor={id}&limit={n}` (default 50, max 200).
+- Timestamps are ISO 8601 with offset.
+- Errors follow RFC 9457 `application/problem+json`.
+- Mutations to a form or any of its children (fields, elements, actions, rules) increment `FormDefinition.Version` and update `UpdatedAt`.
+- The Custom Forms model is product-agnostic: the consuming product owns auth, identity resolution, and AV scanning of uploaded files. Mackinac validates the identity contract and persists/executes submissions.
+ * OpenAPI spec version: v1
+ */
+/**
+ * A user-management view of an Auth0 identity, joined with its linked Staff
+row. `email`, `displayName`, and `roleIds` are populated
+from Auth0 by the service after the Mackinac-side join; they are null
+when Auth0 has not yet been queried (e.g. cheap list view without role
+hydration).
+ */
+export interface UserDto {
+    id?: number;
+    /** @nullable */
+    auth0Sub?: string | null;
+    /** @nullable */
+    staffId?: string | null;
+    /** @nullable */
+    organizationId?: string | null;
+    /** @nullable */
+    email?: string | null;
+    /** @nullable */
+    displayName?: string | null;
+    isBlocked?: boolean;
+    isStaffInactive?: boolean;
+    /** @nullable */
+    staffName?: string | null;
+    /** @nullable */
+    title?: string | null;
+    /** @nullable */
+    lastInvitedAt?: string | null;
+    createdAt?: string;
+    /** @nullable */
+    updatedAt?: string | null;
+    /** @nullable */
+    roleIds?: string[] | null;
+}

package/dist/generated/models/userDto.js

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * Do not edit manually.
+ * Mackinac API
+ * Mackinac API - feature parity with Golden Gate.
+
+**Custom Forms conventions**
+
+- UUIDs are lowercase hyphenated strings.
+- Pagination is cursor-based: `?cursor={id}&limit={n}` (default 50, max 200).
+- Timestamps are ISO 8601 with offset.
+- Errors follow RFC 9457 `application/problem+json`.
+- Mutations to a form or any of its children (fields, elements, actions, rules) increment `FormDefinition.Version` and update `UpdatedAt`.
+- The Custom Forms model is product-agnostic: the consuming product owns auth, identity resolution, and AV scanning of uploaded files. Mackinac validates the identity contract and persists/executes submissions.
+ * OpenAPI spec version: v1
+ */
+export {};

package/dist/generated/models/userDtoCursorPagedResultDto.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * Do not edit manually.
+ * Mackinac API
+ * Mackinac API - feature parity with Golden Gate.
+
+**Custom Forms conventions**
+
+- UUIDs are lowercase hyphenated strings.
+- Pagination is cursor-based: `?cursor={id}&limit={n}` (default 50, max 200).
+- Timestamps are ISO 8601 with offset.
+- Errors follow RFC 9457 `application/problem+json`.
+- Mutations to a form or any of its children (fields, elements, actions, rules) increment `FormDefinition.Version` and update `UpdatedAt`.
+- The Custom Forms model is product-agnostic: the consuming product owns auth, identity resolution, and AV scanning of uploaded files. Mackinac validates the identity contract and persists/executes submissions.
+ * OpenAPI spec version: v1
+ */
+import type { UserDto } from './userDto';
+export interface UserDtoCursorPagedResultDto {
+    /** @nullable */
+    data?: UserDto[] | null;
+    /** @nullable */
+    cursor?: string | null;
+}

package/dist/generated/models/userDtoCursorPagedResultDto.js

@@ -0,0 +1 @@
+export {};

package/dist/generated/models/viewCodeDto.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * Do not edit manually.
+ * Mackinac API
+ * Mackinac API - feature parity with Golden Gate.
+
+**Custom Forms conventions**
+
+- UUIDs are lowercase hyphenated strings.
+- Pagination is cursor-based: `?cursor={id}&limit={n}` (default 50, max 200).
+- Timestamps are ISO 8601 with offset.
+- Errors follow RFC 9457 `application/problem+json`.
+- Mutations to a form or any of its children (fields, elements, actions, rules) increment `FormDefinition.Version` and update `UpdatedAt`.
+- The Custom Forms model is product-agnostic: the consuming product owns auth, identity resolution, and AV scanning of uploaded files. Mackinac validates the identity contract and persists/executes submissions.
+ * OpenAPI spec version: v1
+ */
+/**
+ * Lean read-only projection of a `CODES` row for system-code lookup endpoints
+(`/api/v1/codes/...`). Matches the legacy golden-gate shape:
+`{ codeAlias, description, inactive }`.
+ */
+export interface ViewCodeDto {
+    /** @nullable */
+    codeAlias?: string | null;
+    /** @nullable */
+    description?: string | null;
+    inactive?: boolean;
+}

package/dist/generated/models/viewCodeDto.js

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * Do not edit manually.
+ * Mackinac API
+ * Mackinac API - feature parity with Golden Gate.
+
+**Custom Forms conventions**
+
+- UUIDs are lowercase hyphenated strings.
+- Pagination is cursor-based: `?cursor={id}&limit={n}` (default 50, max 200).
+- Timestamps are ISO 8601 with offset.
+- Errors follow RFC 9457 `application/problem+json`.
+- Mutations to a form or any of its children (fields, elements, actions, rules) increment `FormDefinition.Version` and update `UpdatedAt`.
+- The Custom Forms model is product-agnostic: the consuming product owns auth, identity resolution, and AV scanning of uploaded files. Mackinac validates the identity contract and persists/executes submissions.
+ * OpenAPI spec version: v1
+ */
+export {};

package/dist/generated/models/viewCodeWithTypeDto.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * Do not edit manually.
+ * Mackinac API
+ * Mackinac API - feature parity with Golden Gate.
+
+**Custom Forms conventions**
+
+- UUIDs are lowercase hyphenated strings.
+- Pagination is cursor-based: `?cursor={id}&limit={n}` (default 50, max 200).
+- Timestamps are ISO 8601 with offset.
+- Errors follow RFC 9457 `application/problem+json`.
+- Mutations to a form or any of its children (fields, elements, actions, rules) increment `FormDefinition.Version` and update `UpdatedAt`.
+- The Custom Forms model is product-agnostic: the consuming product owns auth, identity resolution, and AV scanning of uploaded files. Mackinac validates the identity contract and persists/executes submissions.
+ * OpenAPI spec version: v1
+ */
+/**
+ * Extends MackinacService.DTOs.ViewCodeDto with `id` and `type` fields. Used by
+the document and note lookup endpoints (`notetypes`, `doctypes`,
+`doccategories`) where the client also needs the auto-id and code_type.
+ */
+export interface ViewCodeWithTypeDto {
+    /** @nullable */
+    codeAlias?: string | null;
+    /** @nullable */
+    description?: string | null;
+    inactive?: boolean;
+    id?: number;
+    /** @nullable */
+    type?: string | null;
+}

package/dist/generated/models/viewCodeWithTypeDto.js

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * Do not edit manually.
+ * Mackinac API
+ * Mackinac API - feature parity with Golden Gate.
+
+**Custom Forms conventions**
+
+- UUIDs are lowercase hyphenated strings.
+- Pagination is cursor-based: `?cursor={id}&limit={n}` (default 50, max 200).
+- Timestamps are ISO 8601 with offset.
+- Errors follow RFC 9457 `application/problem+json`.
+- Mutations to a form or any of its children (fields, elements, actions, rules) increment `FormDefinition.Version` and update `UpdatedAt`.
+- The Custom Forms model is product-agnostic: the consuming product owns auth, identity resolution, and AV scanning of uploaded files. Mackinac validates the identity contract and persists/executes submissions.
+ * OpenAPI spec version: v1
+ */
+export {};

package/dist/generated/models/viewStaffDto.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * Do not edit manually.
+ * Mackinac API
+ * Mackinac API - feature parity with Golden Gate.
+
+**Custom Forms conventions**
+
+- UUIDs are lowercase hyphenated strings.
+- Pagination is cursor-based: `?cursor={id}&limit={n}` (default 50, max 200).
+- Timestamps are ISO 8601 with offset.
+- Errors follow RFC 9457 `application/problem+json`.
+- Mutations to a form or any of its children (fields, elements, actions, rules) increment `FormDefinition.Version` and update `UpdatedAt`.
+- The Custom Forms model is product-agnostic: the consuming product owns auth, identity resolution, and AV scanning of uploaded files. Mackinac validates the identity contract and persists/executes submissions.
+ * OpenAPI spec version: v1
+ */
+/**
+ * Lean staff row for system-people lookup endpoints.
+ */
+export interface ViewStaffDto {
+    /** @nullable */
+    staffId?: string | null;
+    /** @nullable */
+    name?: string | null;
+    inactive?: boolean;
+}

package/dist/generated/models/viewStaffDto.js

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * Do not edit manually.
+ * Mackinac API
+ * Mackinac API - feature parity with Golden Gate.
+
+**Custom Forms conventions**
+
+- UUIDs are lowercase hyphenated strings.
+- Pagination is cursor-based: `?cursor={id}&limit={n}` (default 50, max 200).
+- Timestamps are ISO 8601 with offset.
+- Errors follow RFC 9457 `application/problem+json`.
+- Mutations to a form or any of its children (fields, elements, actions, rules) increment `FormDefinition.Version` and update `UpdatedAt`.
+- The Custom Forms model is product-agnostic: the consuming product owns auth, identity resolution, and AV scanning of uploaded files. Mackinac validates the identity contract and persists/executes submissions.
+ * OpenAPI spec version: v1
+ */
+export {};

package/dist/generated/models/viewStaffWithTypeDto.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * Do not edit manually.
+ * Mackinac API
+ * Mackinac API - feature parity with Golden Gate.
+
+**Custom Forms conventions**
+
+- UUIDs are lowercase hyphenated strings.
+- Pagination is cursor-based: `?cursor={id}&limit={n}` (default 50, max 200).
+- Timestamps are ISO 8601 with offset.
+- Errors follow RFC 9457 `application/problem+json`.
+- Mutations to a form or any of its children (fields, elements, actions, rules) increment `FormDefinition.Version` and update `UpdatedAt`.
+- The Custom Forms model is product-agnostic: the consuming product owns auth, identity resolution, and AV scanning of uploaded files. Mackinac validates the identity contract and persists/executes submissions.
+ * OpenAPI spec version: v1
+ */
+/**
+ * Adds the systemtype as `type`; used by `/api/v1/people/staff/{m}`.
+ */
+export interface ViewStaffWithTypeDto {
+    /** @nullable */
+    staffId?: string | null;
+    /** @nullable */
+    name?: string | null;
+    inactive?: boolean;
+    /** @nullable */
+    type?: string | null;
+}

package/dist/generated/models/viewStaffWithTypeDto.js

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * Do not edit manually.
+ * Mackinac API
+ * Mackinac API - feature parity with Golden Gate.
+
+**Custom Forms conventions**
+
+- UUIDs are lowercase hyphenated strings.
+- Pagination is cursor-based: `?cursor={id}&limit={n}` (default 50, max 200).
+- Timestamps are ISO 8601 with offset.
+- Errors follow RFC 9457 `application/problem+json`.
+- Mutations to a form or any of its children (fields, elements, actions, rules) increment `FormDefinition.Version` and update `UpdatedAt`.
+- The Custom Forms model is product-agnostic: the consuming product owns auth, identity resolution, and AV scanning of uploaded files. Mackinac validates the identity contract and persists/executes submissions.
+ * OpenAPI spec version: v1
+ */
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cycomdatasystems/mackinac-sdk",
-  "version": "5.0.0",
+  "version": "5.2.1",
   "description": "A shared TypeScript client for the Mackinac API.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",