@constructive-io/sdk 0.0.4 → 0.1.0

package/esm/admin/orm/query/index.d.ts

@@ -30,21 +30,39 @@ export interface OrgPermissionsGetMaskByNamesVariables {
 }
 export interface AppPermissionsGetByMaskVariables {
     mask?: string;
+    /** Only read the first `n` values of the set. */
     first?: number;
+    /**
+     * Skip the first `n` values from our `after` cursor, an alternative to cursor
+     * based pagination. May not be used with `last`.
+     */
     offset?: number;
+    /** Read all values in the set after (below) this cursor. */
     after?: string;
 }
 export interface OrgPermissionsGetByMaskVariables {
     mask?: string;
+    /** Only read the first `n` values of the set. */
     first?: number;
+    /**
+     * Skip the first `n` values from our `after` cursor, an alternative to cursor
+     * based pagination. May not be used with `last`.
+     */
     offset?: number;
+    /** Read all values in the set after (below) this cursor. */
     after?: string;
 }
 export interface StepsRequiredVariables {
     vlevel?: string;
     vroleId?: string;
+    /** Only read the first `n` values of the set. */
     first?: number;
+    /**
+     * Skip the first `n` values from our `after` cursor, an alternative to cursor
+     * based pagination. May not be used with `last`.
+     */
     offset?: number;
+    /** Read all values in the set after (below) this cursor. */
     after?: string;
 }
 export declare function createQueryOperations(client: OrmClient): {

package/esm/auth/orm/input-types.d.ts

@@ -251,8 +251,11 @@ export interface PhoneNumber {
 export interface ConnectedAccount {
     id: string;
     ownerId?: string | null;
+    /** The service used, e.g. `twitter` or `github`. */
     service?: string | null;
+    /** A unique identifier for the user within the service */
     identifier?: string | null;
+    /** Additional profile details extracted from this login method */
     details?: Record<string, unknown> | null;
     isVerified?: boolean | null;
     createdAt?: string | null;
@@ -286,6 +289,7 @@ export interface User {
     type?: number | null;
     createdAt?: string | null;
     updatedAt?: string | null;
+    /** Full-text search ranking when filtered by `searchTsv`. Returns null when no search condition is active. */
     searchTsvRank?: number | null;
 }
 export interface ConnectionResult<T> {
@@ -814,12 +818,23 @@ export interface VerifyTotpInput {
     clientMutationId?: string;
     totpValue: string;
 }
+/** An interval of time that has passed where the smallest distinct unit is a second. */
 export interface IntervalInput {
+    /**
+     * A quantity of seconds. This is the only non-integer field, as all the other
+     * fields will dump their overflow into a smaller unit of time. Intervals don’t
+     * have a smaller unit than seconds.
+     */
     seconds?: number;
+    /** A quantity of minutes. */
     minutes?: number;
+    /** A quantity of hours. */
     hours?: number;
+    /** A quantity of days. */
     days?: number;
+    /** A quantity of months. */
     months?: number;
+    /** A quantity of years. */
     years?: number;
 }
 export interface SignOutPayload {
@@ -958,6 +973,7 @@ export type VerifyTotpPayloadSelect = {
 };
 export interface CreateRoleTypePayload {
     clientMutationId?: string | null;
+    /** The `RoleType` that was created by this mutation. */
     roleType?: RoleType | null;
     roleTypeEdge?: RoleTypeEdge | null;
 }
@@ -972,6 +988,7 @@ export type CreateRoleTypePayloadSelect = {
 };
 export interface UpdateRoleTypePayload {
     clientMutationId?: string | null;
+    /** The `RoleType` that was updated by this mutation. */
     roleType?: RoleType | null;
     roleTypeEdge?: RoleTypeEdge | null;
 }
@@ -986,6 +1003,7 @@ export type UpdateRoleTypePayloadSelect = {
 };
 export interface DeleteRoleTypePayload {
     clientMutationId?: string | null;
+    /** The `RoleType` that was deleted by this mutation. */
     roleType?: RoleType | null;
     roleTypeEdge?: RoleTypeEdge | null;
 }
@@ -1000,6 +1018,7 @@ export type DeleteRoleTypePayloadSelect = {
 };
 export interface CreateCryptoAddressPayload {
     clientMutationId?: string | null;
+    /** The `CryptoAddress` that was created by this mutation. */
     cryptoAddress?: CryptoAddress | null;
     cryptoAddressEdge?: CryptoAddressEdge | null;
 }
@@ -1014,6 +1033,7 @@ export type CreateCryptoAddressPayloadSelect = {
 };
 export interface UpdateCryptoAddressPayload {
     clientMutationId?: string | null;
+    /** The `CryptoAddress` that was updated by this mutation. */
     cryptoAddress?: CryptoAddress | null;
     cryptoAddressEdge?: CryptoAddressEdge | null;
 }
@@ -1028,6 +1048,7 @@ export type UpdateCryptoAddressPayloadSelect = {
 };
 export interface DeleteCryptoAddressPayload {
     clientMutationId?: string | null;
+    /** The `CryptoAddress` that was deleted by this mutation. */
     cryptoAddress?: CryptoAddress | null;
     cryptoAddressEdge?: CryptoAddressEdge | null;
 }
@@ -1042,6 +1063,7 @@ export type DeleteCryptoAddressPayloadSelect = {
 };
 export interface CreatePhoneNumberPayload {
     clientMutationId?: string | null;
+    /** The `PhoneNumber` that was created by this mutation. */
     phoneNumber?: PhoneNumber | null;
     phoneNumberEdge?: PhoneNumberEdge | null;
 }
@@ -1056,6 +1078,7 @@ export type CreatePhoneNumberPayloadSelect = {
 };
 export interface UpdatePhoneNumberPayload {
     clientMutationId?: string | null;
+    /** The `PhoneNumber` that was updated by this mutation. */
     phoneNumber?: PhoneNumber | null;
     phoneNumberEdge?: PhoneNumberEdge | null;
 }
@@ -1070,6 +1093,7 @@ export type UpdatePhoneNumberPayloadSelect = {
 };
 export interface DeletePhoneNumberPayload {
     clientMutationId?: string | null;
+    /** The `PhoneNumber` that was deleted by this mutation. */
     phoneNumber?: PhoneNumber | null;
     phoneNumberEdge?: PhoneNumberEdge | null;
 }
@@ -1084,6 +1108,7 @@ export type DeletePhoneNumberPayloadSelect = {
 };
 export interface CreateConnectedAccountPayload {
     clientMutationId?: string | null;
+    /** The `ConnectedAccount` that was created by this mutation. */
     connectedAccount?: ConnectedAccount | null;
     connectedAccountEdge?: ConnectedAccountEdge | null;
 }
@@ -1098,6 +1123,7 @@ export type CreateConnectedAccountPayloadSelect = {
 };
 export interface UpdateConnectedAccountPayload {
     clientMutationId?: string | null;
+    /** The `ConnectedAccount` that was updated by this mutation. */
     connectedAccount?: ConnectedAccount | null;
     connectedAccountEdge?: ConnectedAccountEdge | null;
 }
@@ -1112,6 +1138,7 @@ export type UpdateConnectedAccountPayloadSelect = {
 };
 export interface DeleteConnectedAccountPayload {
     clientMutationId?: string | null;
+    /** The `ConnectedAccount` that was deleted by this mutation. */
     connectedAccount?: ConnectedAccount | null;
     connectedAccountEdge?: ConnectedAccountEdge | null;
 }
@@ -1126,6 +1153,7 @@ export type DeleteConnectedAccountPayloadSelect = {
 };
 export interface CreateEmailPayload {
     clientMutationId?: string | null;
+    /** The `Email` that was created by this mutation. */
     email?: Email | null;
     emailEdge?: EmailEdge | null;
 }
@@ -1140,6 +1168,7 @@ export type CreateEmailPayloadSelect = {
 };
 export interface UpdateEmailPayload {
     clientMutationId?: string | null;
+    /** The `Email` that was updated by this mutation. */
     email?: Email | null;
     emailEdge?: EmailEdge | null;
 }
@@ -1154,6 +1183,7 @@ export type UpdateEmailPayloadSelect = {
 };
 export interface DeleteEmailPayload {
     clientMutationId?: string | null;
+    /** The `Email` that was deleted by this mutation. */
     email?: Email | null;
     emailEdge?: EmailEdge | null;
 }
@@ -1168,6 +1198,7 @@ export type DeleteEmailPayloadSelect = {
 };
 export interface CreateAuditLogPayload {
     clientMutationId?: string | null;
+    /** The `AuditLog` that was created by this mutation. */
     auditLog?: AuditLog | null;
     auditLogEdge?: AuditLogEdge | null;
 }
@@ -1182,6 +1213,7 @@ export type CreateAuditLogPayloadSelect = {
 };
 export interface UpdateAuditLogPayload {
     clientMutationId?: string | null;
+    /** The `AuditLog` that was updated by this mutation. */
     auditLog?: AuditLog | null;
     auditLogEdge?: AuditLogEdge | null;
 }
@@ -1196,6 +1228,7 @@ export type UpdateAuditLogPayloadSelect = {
 };
 export interface DeleteAuditLogPayload {
     clientMutationId?: string | null;
+    /** The `AuditLog` that was deleted by this mutation. */
     auditLog?: AuditLog | null;
     auditLogEdge?: AuditLogEdge | null;
 }
@@ -1210,6 +1243,7 @@ export type DeleteAuditLogPayloadSelect = {
 };
 export interface CreateUserPayload {
     clientMutationId?: string | null;
+    /** The `User` that was created by this mutation. */
     user?: User | null;
     userEdge?: UserEdge | null;
 }
@@ -1224,6 +1258,7 @@ export type CreateUserPayloadSelect = {
 };
 export interface UpdateUserPayload {
     clientMutationId?: string | null;
+    /** The `User` that was updated by this mutation. */
     user?: User | null;
     userEdge?: UserEdge | null;
 }
@@ -1238,6 +1273,7 @@ export type UpdateUserPayloadSelect = {
 };
 export interface DeleteUserPayload {
     clientMutationId?: string | null;
+    /** The `User` that was deleted by this mutation. */
     user?: User | null;
     userEdge?: UserEdge | null;
 }
@@ -1340,8 +1376,10 @@ export type SessionSelect = {
     createdAt?: boolean;
     updatedAt?: boolean;
 };
+/** A `RoleType` edge in the connection. */
 export interface RoleTypeEdge {
     cursor?: string | null;
+    /** The `RoleType` at the end of the edge. */
     node?: RoleType | null;
 }
 export type RoleTypeEdgeSelect = {
@@ -1350,8 +1388,10 @@ export type RoleTypeEdgeSelect = {
         select: RoleTypeSelect;
     };
 };
+/** A `CryptoAddress` edge in the connection. */
 export interface CryptoAddressEdge {
     cursor?: string | null;
+    /** The `CryptoAddress` at the end of the edge. */
     node?: CryptoAddress | null;
 }
 export type CryptoAddressEdgeSelect = {
@@ -1360,8 +1400,10 @@ export type CryptoAddressEdgeSelect = {
         select: CryptoAddressSelect;
     };
 };
+/** A `PhoneNumber` edge in the connection. */
 export interface PhoneNumberEdge {
     cursor?: string | null;
+    /** The `PhoneNumber` at the end of the edge. */
     node?: PhoneNumber | null;
 }
 export type PhoneNumberEdgeSelect = {
@@ -1370,8 +1412,10 @@ export type PhoneNumberEdgeSelect = {
         select: PhoneNumberSelect;
     };
 };
+/** A `ConnectedAccount` edge in the connection. */
 export interface ConnectedAccountEdge {
     cursor?: string | null;
+    /** The `ConnectedAccount` at the end of the edge. */
     node?: ConnectedAccount | null;
 }
 export type ConnectedAccountEdgeSelect = {
@@ -1380,8 +1424,10 @@ export type ConnectedAccountEdgeSelect = {
         select: ConnectedAccountSelect;
     };
 };
+/** A `Email` edge in the connection. */
 export interface EmailEdge {
     cursor?: string | null;
+    /** The `Email` at the end of the edge. */
     node?: Email | null;
 }
 export type EmailEdgeSelect = {
@@ -1390,8 +1436,10 @@ export type EmailEdgeSelect = {
         select: EmailSelect;
     };
 };
+/** A `AuditLog` edge in the connection. */
 export interface AuditLogEdge {
     cursor?: string | null;
+    /** The `AuditLog` at the end of the edge. */
     node?: AuditLog | null;
 }
 export type AuditLogEdgeSelect = {
@@ -1400,8 +1448,10 @@ export type AuditLogEdgeSelect = {
         select: AuditLogSelect;
     };
 };
+/** A `User` edge in the connection. */
 export interface UserEdge {
     cursor?: string | null;
+    /** The `User` at the end of the edge. */
     node?: User | null;
 }
 export type UserEdgeSelect = {

package/esm/objects/orm/input-types.d.ts

@@ -236,28 +236,44 @@ export interface Object {
     frzn?: boolean | null;
     createdAt?: string | null;
 }
+/** A ref is a data structure for pointing to a commit. */
 export interface Ref {
+    /** The primary unique identifier for the ref. */
     id: string;
+    /** The name of the ref or branch */
     name?: string | null;
     databaseId?: string | null;
     storeId?: string | null;
     commitId?: string | null;
 }
+/** A store represents an isolated object repository within a database. */
 export interface Store {
+    /** The primary unique identifier for the store. */
     id: string;
+    /** The name of the store (e.g., metaschema, migrations). */
     name?: string | null;
+    /** The database this store belongs to. */
     databaseId?: string | null;
+    /** The current head tree_id for this store. */
     hash?: string | null;
     createdAt?: string | null;
 }
+/** A commit records changes to the repository. */
 export interface Commit {
+    /** The primary unique identifier for the commit. */
     id: string;
+    /** The commit message */
     message?: string | null;
+    /** The repository identifier */
     databaseId?: string | null;
     storeId?: string | null;
+    /** Parent commits */
     parentIds?: string | null;
+    /** The author of the commit */
     authorId?: string | null;
+    /** The committer of the commit */
     committerId?: string | null;
+    /** The root of the tree */
     treeId?: string | null;
     date?: string | null;
 }
@@ -609,6 +625,7 @@ export interface SetAndCommitInput {
     kids?: string[];
     ktree?: string[];
 }
+/** A connection to a list of `Object` values. */
 export interface ObjectConnection {
     nodes: Object[];
     edges: ObjectEdge[];
@@ -689,6 +706,7 @@ export type SetAndCommitPayloadSelect = {
 };
 export interface CreateObjectPayload {
     clientMutationId?: string | null;
+    /** The `Object` that was created by this mutation. */
     object?: Object | null;
     objectEdge?: ObjectEdge | null;
 }
@@ -703,6 +721,7 @@ export type CreateObjectPayloadSelect = {
 };
 export interface UpdateObjectPayload {
     clientMutationId?: string | null;
+    /** The `Object` that was updated by this mutation. */
     object?: Object | null;
     objectEdge?: ObjectEdge | null;
 }
@@ -717,6 +736,7 @@ export type UpdateObjectPayloadSelect = {
 };
 export interface DeleteObjectPayload {
     clientMutationId?: string | null;
+    /** The `Object` that was deleted by this mutation. */
     object?: Object | null;
     objectEdge?: ObjectEdge | null;
 }
@@ -731,6 +751,7 @@ export type DeleteObjectPayloadSelect = {
 };
 export interface CreateRefPayload {
     clientMutationId?: string | null;
+    /** The `Ref` that was created by this mutation. */
     ref?: Ref | null;
     refEdge?: RefEdge | null;
 }
@@ -745,6 +766,7 @@ export type CreateRefPayloadSelect = {
 };
 export interface UpdateRefPayload {
     clientMutationId?: string | null;
+    /** The `Ref` that was updated by this mutation. */
     ref?: Ref | null;
     refEdge?: RefEdge | null;
 }
@@ -759,6 +781,7 @@ export type UpdateRefPayloadSelect = {
 };
 export interface DeleteRefPayload {
     clientMutationId?: string | null;
+    /** The `Ref` that was deleted by this mutation. */
     ref?: Ref | null;
     refEdge?: RefEdge | null;
 }
@@ -773,6 +796,7 @@ export type DeleteRefPayloadSelect = {
 };
 export interface CreateStorePayload {
     clientMutationId?: string | null;
+    /** The `Store` that was created by this mutation. */
     store?: Store | null;
     storeEdge?: StoreEdge | null;
 }
@@ -787,6 +811,7 @@ export type CreateStorePayloadSelect = {
 };
 export interface UpdateStorePayload {
     clientMutationId?: string | null;
+    /** The `Store` that was updated by this mutation. */
     store?: Store | null;
     storeEdge?: StoreEdge | null;
 }
@@ -801,6 +826,7 @@ export type UpdateStorePayloadSelect = {
 };
 export interface DeleteStorePayload {
     clientMutationId?: string | null;
+    /** The `Store` that was deleted by this mutation. */
     store?: Store | null;
     storeEdge?: StoreEdge | null;
 }
@@ -815,6 +841,7 @@ export type DeleteStorePayloadSelect = {
 };
 export interface CreateCommitPayload {
     clientMutationId?: string | null;
+    /** The `Commit` that was created by this mutation. */
     commit?: Commit | null;
     commitEdge?: CommitEdge | null;
 }
@@ -829,6 +856,7 @@ export type CreateCommitPayloadSelect = {
 };
 export interface UpdateCommitPayload {
     clientMutationId?: string | null;
+    /** The `Commit` that was updated by this mutation. */
     commit?: Commit | null;
     commitEdge?: CommitEdge | null;
 }
@@ -843,6 +871,7 @@ export type UpdateCommitPayloadSelect = {
 };
 export interface DeleteCommitPayload {
     clientMutationId?: string | null;
+    /** The `Commit` that was deleted by this mutation. */
     commit?: Commit | null;
     commitEdge?: CommitEdge | null;
 }
@@ -855,8 +884,10 @@ export type DeleteCommitPayloadSelect = {
         select: CommitEdgeSelect;
     };
 };
+/** A `Object` edge in the connection. */
 export interface ObjectEdge {
     cursor?: string | null;
+    /** The `Object` at the end of the edge. */
     node?: Object | null;
 }
 export type ObjectEdgeSelect = {
@@ -865,10 +896,15 @@ export type ObjectEdgeSelect = {
         select: ObjectSelect;
     };
 };
+/** Information about pagination in a connection. */
 export interface PageInfo {
+    /** When paginating forwards, are there more items? */
     hasNextPage: boolean;
+    /** When paginating backwards, are there more items? */
     hasPreviousPage: boolean;
+    /** When paginating backwards, the cursor to continue. */
     startCursor?: string | null;
+    /** When paginating forwards, the cursor to continue. */
     endCursor?: string | null;
 }
 export type PageInfoSelect = {
@@ -877,8 +913,10 @@ export type PageInfoSelect = {
     startCursor?: boolean;
     endCursor?: boolean;
 };
+/** A `Ref` edge in the connection. */
 export interface RefEdge {
     cursor?: string | null;
+    /** The `Ref` at the end of the edge. */
     node?: Ref | null;
 }
 export type RefEdgeSelect = {
@@ -887,8 +925,10 @@ export type RefEdgeSelect = {
         select: RefSelect;
     };
 };
+/** A `Store` edge in the connection. */
 export interface StoreEdge {
     cursor?: string | null;
+    /** The `Store` at the end of the edge. */
     node?: Store | null;
 }
 export type StoreEdgeSelect = {
@@ -897,8 +937,10 @@ export type StoreEdgeSelect = {
         select: StoreSelect;
     };
 };
+/** A `Commit` edge in the connection. */
 export interface CommitEdge {
     cursor?: string | null;
+    /** The `Commit` at the end of the edge. */
     node?: Commit | null;
 }
 export type CommitEdgeSelect = {

package/esm/objects/orm/query/index.d.ts

@@ -15,16 +15,28 @@ export interface RevParseVariables {
 export interface GetAllObjectsFromRootVariables {
     databaseId?: string;
     id?: string;
+    /** Only read the first `n` values of the set. */
     first?: number;
+    /**
+     * Skip the first `n` values from our `after` cursor, an alternative to cursor
+     * based pagination. May not be used with `last`.
+     */
     offset?: number;
+    /** Read all values in the set after (below) this cursor. */
     after?: string;
 }
 export interface GetPathObjectsFromRootVariables {
     databaseId?: string;
     id?: string;
     path?: string[];
+    /** Only read the first `n` values of the set. */
     first?: number;
+    /**
+     * Skip the first `n` values from our `after` cursor, an alternative to cursor
+     * based pagination. May not be used with `last`.
+     */
     offset?: number;
+    /** Read all values in the set after (below) this cursor. */
     after?: string;
 }
 export interface GetObjectAtPathVariables {