@contractspec/example.saas-boilerplate 1.57.0 → 1.59.0

package/dist/node/project/project.operations.js

@@ -0,0 +1,372 @@
+// src/project/project.enum.ts
+import { defineEnum } from "@contractspec/lib.schema";
+var ProjectStatusSchemaEnum = defineEnum("ProjectStatus", [
+  "DRAFT",
+  "ACTIVE",
+  "ARCHIVED",
+  "DELETED"
+]);
+var ProjectStatusFilterEnum = defineEnum("ProjectStatusFilter", [
+  "DRAFT",
+  "ACTIVE",
+  "ARCHIVED",
+  "all"
+]);
+
+// src/project/project.schema.ts
+import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
+var ProjectModel = defineSchemaModel({
+  name: "Project",
+  description: "A project within an organization",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    description: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    slug: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    organizationId: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: false
+    },
+    createdBy: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    status: { type: ProjectStatusSchemaEnum, isOptional: false },
+    isPublic: { type: ScalarTypeEnum.Boolean(), isOptional: false },
+    tags: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isArray: true,
+      isOptional: false
+    },
+    createdAt: { type: ScalarTypeEnum.DateTime(), isOptional: false },
+    updatedAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var CreateProjectInputModel = defineSchemaModel({
+  name: "CreateProjectInput",
+  description: "Input for creating a project",
+  fields: {
+    name: { type: ScalarTypeEnum.NonEmptyString(), isOptional: false },
+    description: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    slug: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    isPublic: { type: ScalarTypeEnum.Boolean(), isOptional: true },
+    tags: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isArray: true,
+      isOptional: true
+    }
+  }
+});
+var UpdateProjectInputModel = defineSchemaModel({
+  name: "UpdateProjectInput",
+  description: "Input for updating a project",
+  fields: {
+    projectId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    description: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    slug: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    isPublic: { type: ScalarTypeEnum.Boolean(), isOptional: true },
+    tags: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isArray: true,
+      isOptional: true
+    },
+    status: { type: ProjectStatusSchemaEnum, isOptional: true }
+  }
+});
+var GetProjectInputModel = defineSchemaModel({
+  name: "GetProjectInput",
+  fields: {
+    projectId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var DeleteProjectInputModel = defineSchemaModel({
+  name: "DeleteProjectInput",
+  fields: {
+    projectId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var DeleteProjectOutputModel = defineSchemaModel({
+  name: "DeleteProjectOutput",
+  fields: {
+    success: { type: ScalarTypeEnum.Boolean(), isOptional: false }
+  }
+});
+var ProjectDeletedPayloadModel = defineSchemaModel({
+  name: "ProjectDeletedPayload",
+  fields: {
+    projectId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var ListProjectsInputModel = defineSchemaModel({
+  name: "ListProjectsInput",
+  description: "Input for listing projects",
+  fields: {
+    status: { type: ProjectStatusFilterEnum, isOptional: true },
+    search: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    limit: {
+      type: ScalarTypeEnum.Int_unsecure(),
+      isOptional: true,
+      defaultValue: 20
+    },
+    offset: {
+      type: ScalarTypeEnum.Int_unsecure(),
+      isOptional: true,
+      defaultValue: 0
+    }
+  }
+});
+var ListProjectsOutputModel = defineSchemaModel({
+  name: "ListProjectsOutput",
+  description: "Output for listing projects",
+  fields: {
+    projects: { type: ProjectModel, isArray: true, isOptional: false },
+    total: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false }
+  }
+});
+
+// src/project/project.operations.ts
+import {
+  defineCommand,
+  defineQuery
+} from "@contractspec/lib.contracts/operations";
+var OWNERS = ["example.saas-boilerplate"];
+var CreateProjectContract = defineCommand({
+  meta: {
+    key: "saas.project.create",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["saas", "project", "create"],
+    description: "Create a new project in the organization.",
+    goal: "Allow users to create projects for organizing work.",
+    context: "Called from project creation UI or API."
+  },
+  io: {
+    input: CreateProjectInputModel,
+    output: ProjectModel,
+    errors: {
+      SLUG_EXISTS: {
+        description: "A project with this slug already exists",
+        http: 409,
+        gqlCode: "SLUG_EXISTS",
+        when: "Slug is already taken in the organization"
+      },
+      LIMIT_REACHED: {
+        description: "Project limit reached for this plan",
+        http: 403,
+        gqlCode: "LIMIT_REACHED",
+        when: "Organization has reached project limit"
+      }
+    }
+  },
+  policy: {
+    auth: "user"
+  },
+  sideEffects: {
+    emits: [
+      {
+        key: "project.created",
+        version: "1.0.0",
+        when: "Project is created",
+        payload: ProjectModel
+      }
+    ],
+    audit: ["project.created"]
+  },
+  acceptance: {
+    scenarios: [
+      {
+        key: "create-project-happy-path",
+        given: ["User is authenticated"],
+        when: ["User creates project"],
+        then: ["Project is created", "ProjectCreated event is emitted"]
+      }
+    ],
+    examples: [
+      {
+        key: "create-basic",
+        input: { name: "Website Redesign", slug: "website-redesign" },
+        output: { id: "proj-123", name: "Website Redesign", isArchived: false }
+      }
+    ]
+  }
+});
+var GetProjectContract = defineQuery({
+  meta: {
+    key: "saas.project.get",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["saas", "project", "get"],
+    description: "Get a project by ID.",
+    goal: "Retrieve project details.",
+    context: "Project detail page, API calls."
+  },
+  io: {
+    input: GetProjectInputModel,
+    output: ProjectModel,
+    errors: {
+      NOT_FOUND: {
+        description: "Project not found",
+        http: 404,
+        gqlCode: "NOT_FOUND",
+        when: "Project ID is invalid or user lacks access"
+      }
+    }
+  },
+  policy: {
+    auth: "user"
+  },
+  acceptance: {
+    scenarios: [
+      {
+        key: "get-project-happy-path",
+        given: ["Project exists"],
+        when: ["User requests project"],
+        then: ["Project details are returned"]
+      }
+    ],
+    examples: [
+      {
+        key: "get-existing",
+        input: { projectId: "proj-123" },
+        output: { id: "proj-123", name: "Website Redesign" }
+      }
+    ]
+  }
+});
+var UpdateProjectContract = defineCommand({
+  meta: {
+    key: "saas.project.update",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["saas", "project", "update"],
+    description: "Update project details.",
+    goal: "Allow project owners/editors to modify project.",
+    context: "Project settings page."
+  },
+  io: {
+    input: UpdateProjectInputModel,
+    output: ProjectModel
+  },
+  policy: {
+    auth: "user"
+  },
+  sideEffects: {
+    emits: [
+      {
+        key: "project.updated",
+        version: "1.0.0",
+        when: "Project is updated",
+        payload: ProjectModel
+      }
+    ],
+    audit: ["project.updated"]
+  },
+  acceptance: {
+    scenarios: [
+      {
+        key: "update-project-happy-path",
+        given: ["Project exists"],
+        when: ["User updates description"],
+        then: ["Project is updated", "ProjectUpdated event is emitted"]
+      }
+    ],
+    examples: [
+      {
+        key: "update-desc",
+        input: { projectId: "proj-123", description: "New description" },
+        output: { id: "proj-123", description: "New description" }
+      }
+    ]
+  }
+});
+var DeleteProjectContract = defineCommand({
+  meta: {
+    key: "saas.project.delete",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["saas", "project", "delete"],
+    description: "Delete a project (soft delete).",
+    goal: "Allow project owners to remove projects.",
+    context: "Project settings page."
+  },
+  io: {
+    input: DeleteProjectInputModel,
+    output: DeleteProjectOutputModel
+  },
+  policy: {
+    auth: "user"
+  },
+  sideEffects: {
+    emits: [
+      {
+        key: "project.deleted",
+        version: "1.0.0",
+        when: "Project is deleted",
+        payload: ProjectDeletedPayloadModel
+      }
+    ],
+    audit: ["project.deleted"]
+  },
+  acceptance: {
+    scenarios: [
+      {
+        key: "delete-project-happy-path",
+        given: ["Project exists"],
+        when: ["User deletes project"],
+        then: ["Project is deleted", "ProjectDeleted event is emitted"]
+      }
+    ],
+    examples: [
+      {
+        key: "delete-existing",
+        input: { projectId: "proj-123" },
+        output: { success: true }
+      }
+    ]
+  }
+});
+var ListProjectsContract = defineQuery({
+  meta: {
+    key: "saas.project.list",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["saas", "project", "list"],
+    description: "List projects in the organization.",
+    goal: "Show all projects user has access to.",
+    context: "Project list page, dashboard."
+  },
+  io: {
+    input: ListProjectsInputModel,
+    output: ListProjectsOutputModel
+  },
+  policy: {
+    auth: "user"
+  },
+  acceptance: {
+    scenarios: [
+      {
+        key: "list-projects-happy-path",
+        given: ["Projects exist"],
+        when: ["User lists projects"],
+        then: ["List of projects is returned"]
+      }
+    ],
+    examples: [
+      {
+        key: "list-all",
+        input: { limit: 10 },
+        output: { items: [], total: 5 }
+      }
+    ]
+  }
+});
+export {
+  UpdateProjectContract,
+  ListProjectsContract,
+  GetProjectContract,
+  DeleteProjectContract,
+  CreateProjectContract
+};

package/dist/node/project/project.presentation.js

@@ -0,0 +1,177 @@
+// src/project/project.enum.ts
+import { defineEnum } from "@contractspec/lib.schema";
+var ProjectStatusSchemaEnum = defineEnum("ProjectStatus", [
+  "DRAFT",
+  "ACTIVE",
+  "ARCHIVED",
+  "DELETED"
+]);
+var ProjectStatusFilterEnum = defineEnum("ProjectStatusFilter", [
+  "DRAFT",
+  "ACTIVE",
+  "ARCHIVED",
+  "all"
+]);
+
+// src/project/project.schema.ts
+import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
+var ProjectModel = defineSchemaModel({
+  name: "Project",
+  description: "A project within an organization",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    description: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    slug: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    organizationId: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: false
+    },
+    createdBy: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    status: { type: ProjectStatusSchemaEnum, isOptional: false },
+    isPublic: { type: ScalarTypeEnum.Boolean(), isOptional: false },
+    tags: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isArray: true,
+      isOptional: false
+    },
+    createdAt: { type: ScalarTypeEnum.DateTime(), isOptional: false },
+    updatedAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var CreateProjectInputModel = defineSchemaModel({
+  name: "CreateProjectInput",
+  description: "Input for creating a project",
+  fields: {
+    name: { type: ScalarTypeEnum.NonEmptyString(), isOptional: false },
+    description: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    slug: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    isPublic: { type: ScalarTypeEnum.Boolean(), isOptional: true },
+    tags: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isArray: true,
+      isOptional: true
+    }
+  }
+});
+var UpdateProjectInputModel = defineSchemaModel({
+  name: "UpdateProjectInput",
+  description: "Input for updating a project",
+  fields: {
+    projectId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    description: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    slug: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    isPublic: { type: ScalarTypeEnum.Boolean(), isOptional: true },
+    tags: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isArray: true,
+      isOptional: true
+    },
+    status: { type: ProjectStatusSchemaEnum, isOptional: true }
+  }
+});
+var GetProjectInputModel = defineSchemaModel({
+  name: "GetProjectInput",
+  fields: {
+    projectId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var DeleteProjectInputModel = defineSchemaModel({
+  name: "DeleteProjectInput",
+  fields: {
+    projectId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var DeleteProjectOutputModel = defineSchemaModel({
+  name: "DeleteProjectOutput",
+  fields: {
+    success: { type: ScalarTypeEnum.Boolean(), isOptional: false }
+  }
+});
+var ProjectDeletedPayloadModel = defineSchemaModel({
+  name: "ProjectDeletedPayload",
+  fields: {
+    projectId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var ListProjectsInputModel = defineSchemaModel({
+  name: "ListProjectsInput",
+  description: "Input for listing projects",
+  fields: {
+    status: { type: ProjectStatusFilterEnum, isOptional: true },
+    search: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    limit: {
+      type: ScalarTypeEnum.Int_unsecure(),
+      isOptional: true,
+      defaultValue: 20
+    },
+    offset: {
+      type: ScalarTypeEnum.Int_unsecure(),
+      isOptional: true,
+      defaultValue: 0
+    }
+  }
+});
+var ListProjectsOutputModel = defineSchemaModel({
+  name: "ListProjectsOutput",
+  description: "Output for listing projects",
+  fields: {
+    projects: { type: ProjectModel, isArray: true, isOptional: false },
+    total: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false }
+  }
+});
+
+// src/project/project.presentation.ts
+import { definePresentation, StabilityEnum } from "@contractspec/lib.contracts";
+var ProjectListPresentation = definePresentation({
+  meta: {
+    key: "saas.project.list",
+    version: "1.0.0",
+    title: "Project List",
+    description: "List view of projects with status, tags, and last updated info",
+    domain: "saas-boilerplate",
+    owners: ["@saas-team"],
+    tags: ["project", "list", "dashboard"],
+    stability: StabilityEnum.Beta,
+    goal: "Browse and manage projects",
+    context: "Project list page"
+  },
+  source: {
+    type: "component",
+    framework: "react",
+    componentKey: "ProjectListView",
+    props: ProjectModel
+  },
+  targets: ["react", "markdown", "application/json"],
+  policy: {
+    flags: ["saas.projects.enabled"]
+  }
+});
+var ProjectDetailPresentation = definePresentation({
+  meta: {
+    key: "saas.project.detail",
+    version: "1.0.0",
+    title: "Project Details",
+    description: "Detailed view of a project with settings and activity",
+    domain: "saas-boilerplate",
+    owners: ["@saas-team"],
+    tags: ["project", "detail"],
+    stability: StabilityEnum.Beta,
+    goal: "View and edit project details",
+    context: "Project detail page"
+  },
+  source: {
+    type: "component",
+    framework: "react",
+    componentKey: "ProjectDetailView"
+  },
+  targets: ["react", "markdown"],
+  policy: {
+    flags: ["saas.projects.enabled"]
+  }
+});
+export {
+  ProjectListPresentation,
+  ProjectDetailPresentation
+};

package/dist/node/project/project.schema.js

@@ -0,0 +1,134 @@
+// src/project/project.enum.ts
+import { defineEnum } from "@contractspec/lib.schema";
+var ProjectStatusSchemaEnum = defineEnum("ProjectStatus", [
+  "DRAFT",
+  "ACTIVE",
+  "ARCHIVED",
+  "DELETED"
+]);
+var ProjectStatusFilterEnum = defineEnum("ProjectStatusFilter", [
+  "DRAFT",
+  "ACTIVE",
+  "ARCHIVED",
+  "all"
+]);
+
+// src/project/project.schema.ts
+import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
+var ProjectModel = defineSchemaModel({
+  name: "Project",
+  description: "A project within an organization",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    description: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    slug: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    organizationId: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: false
+    },
+    createdBy: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    status: { type: ProjectStatusSchemaEnum, isOptional: false },
+    isPublic: { type: ScalarTypeEnum.Boolean(), isOptional: false },
+    tags: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isArray: true,
+      isOptional: false
+    },
+    createdAt: { type: ScalarTypeEnum.DateTime(), isOptional: false },
+    updatedAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var CreateProjectInputModel = defineSchemaModel({
+  name: "CreateProjectInput",
+  description: "Input for creating a project",
+  fields: {
+    name: { type: ScalarTypeEnum.NonEmptyString(), isOptional: false },
+    description: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    slug: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    isPublic: { type: ScalarTypeEnum.Boolean(), isOptional: true },
+    tags: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isArray: true,
+      isOptional: true
+    }
+  }
+});
+var UpdateProjectInputModel = defineSchemaModel({
+  name: "UpdateProjectInput",
+  description: "Input for updating a project",
+  fields: {
+    projectId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    description: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    slug: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    isPublic: { type: ScalarTypeEnum.Boolean(), isOptional: true },
+    tags: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isArray: true,
+      isOptional: true
+    },
+    status: { type: ProjectStatusSchemaEnum, isOptional: true }
+  }
+});
+var GetProjectInputModel = defineSchemaModel({
+  name: "GetProjectInput",
+  fields: {
+    projectId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var DeleteProjectInputModel = defineSchemaModel({
+  name: "DeleteProjectInput",
+  fields: {
+    projectId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var DeleteProjectOutputModel = defineSchemaModel({
+  name: "DeleteProjectOutput",
+  fields: {
+    success: { type: ScalarTypeEnum.Boolean(), isOptional: false }
+  }
+});
+var ProjectDeletedPayloadModel = defineSchemaModel({
+  name: "ProjectDeletedPayload",
+  fields: {
+    projectId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
+  }
+});
+var ListProjectsInputModel = defineSchemaModel({
+  name: "ListProjectsInput",
+  description: "Input for listing projects",
+  fields: {
+    status: { type: ProjectStatusFilterEnum, isOptional: true },
+    search: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    limit: {
+      type: ScalarTypeEnum.Int_unsecure(),
+      isOptional: true,
+      defaultValue: 20
+    },
+    offset: {
+      type: ScalarTypeEnum.Int_unsecure(),
+      isOptional: true,
+      defaultValue: 0
+    }
+  }
+});
+var ListProjectsOutputModel = defineSchemaModel({
+  name: "ListProjectsOutput",
+  description: "Output for listing projects",
+  fields: {
+    projects: { type: ProjectModel, isArray: true, isOptional: false },
+    total: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false }
+  }
+});
+export {
+  UpdateProjectInputModel,
+  ProjectModel,
+  ProjectDeletedPayloadModel,
+  ListProjectsOutputModel,
+  ListProjectsInputModel,
+  GetProjectInputModel,
+  DeleteProjectOutputModel,
+  DeleteProjectInputModel,
+  CreateProjectInputModel
+};