crewly 1.0.7 → 1.0.8

package/dist/cli/backend/src/types/knowledge.types.d.ts

@@ -0,0 +1,195 @@
+/**
+ * Knowledge Document Types
+ *
+ * Type definitions for the Company Knowledge system, which stores
+ * markdown documents with YAML frontmatter for team documentation,
+ * SOPs, architecture notes, runbooks, and other company knowledge.
+ *
+ * @module types/knowledge.types
+ */
+/**
+ * Scope of a knowledge document — global (company-wide) or project-specific.
+ */
+export type KnowledgeScope = 'global' | 'project';
+/**
+ * Default document categories available in the knowledge system.
+ */
+export declare const DEFAULT_KNOWLEDGE_CATEGORIES: readonly ["SOPs", "Team Norms", "Architecture", "Onboarding", "Runbooks", "General"];
+/**
+ * Type for default knowledge categories.
+ */
+export type DefaultKnowledgeCategory = (typeof DEFAULT_KNOWLEDGE_CATEGORIES)[number];
+/**
+ * Constants for the knowledge document system.
+ */
+export declare const KNOWLEDGE_CONSTANTS: {
+    /** Maximum content length for a document (500KB) */
+    readonly MAX_CONTENT_LENGTH: 512000;
+    /** Maximum title length */
+    readonly MAX_TITLE_LENGTH: 200;
+    /** Maximum number of tags per document */
+    readonly MAX_TAGS: 20;
+    /** Maximum tag length */
+    readonly MAX_TAG_LENGTH: 50;
+    /** Maximum category name length */
+    readonly MAX_CATEGORY_LENGTH: 50;
+    /** Preview length for document summaries */
+    readonly PREVIEW_LENGTH: 200;
+};
+/**
+ * YAML frontmatter stored at the top of each knowledge document file.
+ */
+export interface KnowledgeFrontmatter {
+    /** Unique document identifier */
+    id: string;
+    /** Document title */
+    title: string;
+    /** Document category (from defaults or custom) */
+    category: string;
+    /** Optional tags for filtering/search */
+    tags: string[];
+    /** Who created the document (user or agent session name) */
+    createdBy: string;
+    /** Who last updated the document */
+    updatedBy: string;
+    /** ISO timestamp of creation */
+    createdAt: string;
+    /** ISO timestamp of last update */
+    updatedAt: string;
+}
+/**
+ * Full knowledge document including frontmatter and markdown content.
+ */
+export interface KnowledgeDocument {
+    /** Unique document identifier */
+    id: string;
+    /** Document title */
+    title: string;
+    /** Document category */
+    category: string;
+    /** Tags for filtering/search */
+    tags: string[];
+    /** Full markdown content (body only, excluding frontmatter) */
+    content: string;
+    /** Document scope */
+    scope: KnowledgeScope;
+    /** Project path if scope is 'project' */
+    projectPath?: string;
+    /** Who created the document */
+    createdBy: string;
+    /** Who last updated the document */
+    updatedBy: string;
+    /** ISO timestamp of creation */
+    createdAt: string;
+    /** ISO timestamp of last update */
+    updatedAt: string;
+}
+/**
+ * Summary of a knowledge document for list views (no full content).
+ */
+export interface KnowledgeDocumentSummary {
+    /** Unique document identifier */
+    id: string;
+    /** Document title */
+    title: string;
+    /** Document category */
+    category: string;
+    /** Tags for filtering/search */
+    tags: string[];
+    /** First N characters of content for preview */
+    preview: string;
+    /** Document scope */
+    scope: KnowledgeScope;
+    /** Who created the document */
+    createdBy: string;
+    /** Who last updated the document */
+    updatedBy: string;
+    /** ISO timestamp of creation */
+    createdAt: string;
+    /** ISO timestamp of last update */
+    updatedAt: string;
+}
+/**
+ * Entry in the knowledge index file for fast listing.
+ */
+export interface KnowledgeIndexEntry {
+    /** Document identifier */
+    id: string;
+    /** Document title */
+    title: string;
+    /** Document category */
+    category: string;
+    /** Tags */
+    tags: string[];
+    /** Content preview */
+    preview: string;
+    /** Who created the document */
+    createdBy: string;
+    /** Who last updated the document */
+    updatedBy: string;
+    /** ISO timestamp of creation */
+    createdAt: string;
+    /** ISO timestamp of last update */
+    updatedAt: string;
+    /** Cached embedding vector for semantic search (set by GeminiEmbeddingStrategy) */
+    embedding?: number[];
+}
+/**
+ * JSON index stored per scope for fast document listing.
+ */
+export interface KnowledgeIndex {
+    /** Schema version for future migrations */
+    version: number;
+    /** Last time the index was updated */
+    updatedAt: string;
+    /** Array of document index entries */
+    entries: KnowledgeIndexEntry[];
+}
+/**
+ * Parameters for creating a new knowledge document.
+ */
+export interface CreateKnowledgeDocumentParams {
+    /** Document title */
+    title: string;
+    /** Markdown content */
+    content: string;
+    /** Document category */
+    category: string;
+    /** Document scope */
+    scope: KnowledgeScope;
+    /** Project path (required when scope is 'project') */
+    projectPath?: string;
+    /** Tags for filtering/search */
+    tags?: string[];
+    /** Who is creating the document */
+    createdBy: string;
+}
+/**
+ * Parameters for updating an existing knowledge document.
+ */
+export interface UpdateKnowledgeDocumentParams {
+    /** Updated title */
+    title?: string;
+    /** Updated markdown content */
+    content?: string;
+    /** Updated category */
+    category?: string;
+    /** Updated tags */
+    tags?: string[];
+    /** Document scope */
+    scope: KnowledgeScope;
+    /** Project path (required when scope is 'project') */
+    projectPath?: string;
+    /** Who is updating the document */
+    updatedBy: string;
+}
+/**
+ * Filters for listing knowledge documents.
+ */
+export interface KnowledgeDocumentFilters {
+    /** Filter by category */
+    category?: string;
+    /** Search query (matches title, tags, preview) */
+    search?: string;
+}
+//# sourceMappingURL=knowledge.types.d.ts.map

package/dist/cli/backend/src/types/knowledge.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"knowledge.types.d.ts","sourceRoot":"","sources":["../../../../../backend/src/types/knowledge.types.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,SAAS,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,4BAA4B,sFAO/B,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,OAAO,4BAA4B,CAAC,CAAC,MAAM,CAAC,CAAC;AAErF;;GAEG;AACH,eAAO,MAAM,mBAAmB;IAC9B,oDAAoD;;IAEpD,2BAA2B;;IAE3B,0CAA0C;;IAE1C,yBAAyB;;IAEzB,mCAAmC;;IAEnC,4CAA4C;;CAEpC,CAAC;AAEX;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,iCAAiC;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,qBAAqB;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,kDAAkD;IAClD,QAAQ,EAAE,MAAM,CAAC;IACjB,yCAAyC;IACzC,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,4DAA4D;IAC5D,SAAS,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,gCAAgC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,iCAAiC;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,qBAAqB;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,wBAAwB;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,gCAAgC;IAChC,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,+DAA+D;IAC/D,OAAO,EAAE,MAAM,CAAC;IAChB,qBAAqB;IACrB,KAAK,EAAE,cAAc,CAAC;IACtB,yCAAyC;IACzC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,+BAA+B;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,gCAAgC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,iCAAiC;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,qBAAqB;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,wBAAwB;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,gCAAgC;IAChC,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,gDAAgD;IAChD,OAAO,EAAE,MAAM,CAAC;IAChB,qBAAqB;IACrB,KAAK,EAAE,cAAc,CAAC;IACtB,+BAA+B;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,gCAAgC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,0BAA0B;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,qBAAqB;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,wBAAwB;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW;IACX,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,sBAAsB;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,+BAA+B;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,gCAAgC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,mFAAmF;IACnF,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,2CAA2C;IAC3C,OAAO,EAAE,MAAM,CAAC;IAChB,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,sCAAsC;IACtC,OAAO,EAAE,mBAAmB,EAAE,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,qBAAqB;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,uBAAuB;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,wBAAwB;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,qBAAqB;IACrB,KAAK,EAAE,cAAc,CAAC;IACtB,sDAAsD;IACtD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gCAAgC;IAChC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,oBAAoB;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uBAAuB;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mBAAmB;IACnB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,qBAAqB;IACrB,KAAK,EAAE,cAAc,CAAC;IACtB,sDAAsD;IACtD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,yBAAyB;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kDAAkD;IAClD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/dist/cli/backend/src/types/knowledge.types.js

@@ -0,0 +1,38 @@
+/**
+ * Knowledge Document Types
+ *
+ * Type definitions for the Company Knowledge system, which stores
+ * markdown documents with YAML frontmatter for team documentation,
+ * SOPs, architecture notes, runbooks, and other company knowledge.
+ *
+ * @module types/knowledge.types
+ */
+/**
+ * Default document categories available in the knowledge system.
+ */
+export const DEFAULT_KNOWLEDGE_CATEGORIES = [
+    'SOPs',
+    'Team Norms',
+    'Architecture',
+    'Onboarding',
+    'Runbooks',
+    'General',
+];
+/**
+ * Constants for the knowledge document system.
+ */
+export const KNOWLEDGE_CONSTANTS = {
+    /** Maximum content length for a document (500KB) */
+    MAX_CONTENT_LENGTH: 512000,
+    /** Maximum title length */
+    MAX_TITLE_LENGTH: 200,
+    /** Maximum number of tags per document */
+    MAX_TAGS: 20,
+    /** Maximum tag length */
+    MAX_TAG_LENGTH: 50,
+    /** Maximum category name length */
+    MAX_CATEGORY_LENGTH: 50,
+    /** Preview length for document summaries */
+    PREVIEW_LENGTH: 200,
+};
+//# sourceMappingURL=knowledge.types.js.map

package/dist/cli/backend/src/types/knowledge.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"knowledge.types.js","sourceRoot":"","sources":["../../../../../backend/src/types/knowledge.types.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAOH;;GAEG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG;IAC1C,MAAM;IACN,YAAY;IACZ,cAAc;IACd,YAAY;IACZ,UAAU;IACV,SAAS;CACD,CAAC;AAOX;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,oDAAoD;IACpD,kBAAkB,EAAE,MAAM;IAC1B,2BAA2B;IAC3B,gBAAgB,EAAE,GAAG;IACrB,0CAA0C;IAC1C,QAAQ,EAAE,EAAE;IACZ,yBAAyB;IACzB,cAAc,EAAE,EAAE;IAClB,mCAAmC;IACnC,mBAAmB,EAAE,EAAE;IACvB,4CAA4C;IAC5C,cAAc,EAAE,GAAG;CACX,CAAC"}