@totoday/quinn-sdk 0.1.3 → 0.2.0

package/dist/index.d.ts

@@ -3,6 +3,7 @@ import { CompetenciesService } from './services/competencies';
 import { CoursesService } from './services/courses';
 import { EndorsementsService } from './services/endorsements';
 import { GroupsService } from './services/groups';
+import { KnowledgeService } from './services/knowledge';
 import { LevelsService } from './services/levels';
 import { MembersService } from './services/members';
 import { OrganizationsService } from './services/organizations';
@@ -15,10 +16,12 @@ export { DEFAULT_QUINN_API_URL, resolveApiUrl, resolveConfigPath, } from './conf
 export type { QuinnClientConfig } from './config';
 export type { QuinnMutationAccess } from './mutation-access';
 export { QuinnMutationAccessError } from './mutation-access';
+export { KnowledgeDocumentsService, KnowledgeFoldersService, KnowledgeService, } from './services/knowledge';
 export declare class Quinn {
     private readonly config;
     private readonly http;
     readonly organizations: OrganizationsService;
+    readonly knowledge: KnowledgeService;
     readonly members: MembersService;
     readonly roles: RolesService;
     readonly levels: LevelsService;

package/dist/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Quinn = exports.QuinnMutationAccessError = exports.resolveConfigPath = exports.resolveApiUrl = exports.DEFAULT_QUINN_API_URL = exports.QuinnAuth = void 0;
+exports.Quinn = exports.KnowledgeService = exports.KnowledgeFoldersService = exports.KnowledgeDocumentsService = exports.QuinnMutationAccessError = exports.resolveConfigPath = exports.resolveApiUrl = exports.DEFAULT_QUINN_API_URL = exports.QuinnAuth = void 0;
 const config_1 = require("./config");
 const http_1 = require("./http");
 const mutation_access_1 = require("./mutation-access");
@@ -22,6 +22,7 @@ const competencies_1 = require("./services/competencies");
 const courses_1 = require("./services/courses");
 const endorsements_1 = require("./services/endorsements");
 const groups_1 = require("./services/groups");
+const knowledge_1 = require("./services/knowledge");
 const levels_1 = require("./services/levels");
 const members_1 = require("./services/members");
 const organizations_1 = require("./services/organizations");
@@ -37,10 +38,15 @@ Object.defineProperty(exports, "resolveApiUrl", { enumerable: true, get: functio
 Object.defineProperty(exports, "resolveConfigPath", { enumerable: true, get: function () { return config_2.resolveConfigPath; } });
 var mutation_access_2 = require("./mutation-access");
 Object.defineProperty(exports, "QuinnMutationAccessError", { enumerable: true, get: function () { return mutation_access_2.QuinnMutationAccessError; } });
+var knowledge_2 = require("./services/knowledge");
+Object.defineProperty(exports, "KnowledgeDocumentsService", { enumerable: true, get: function () { return knowledge_2.KnowledgeDocumentsService; } });
+Object.defineProperty(exports, "KnowledgeFoldersService", { enumerable: true, get: function () { return knowledge_2.KnowledgeFoldersService; } });
+Object.defineProperty(exports, "KnowledgeService", { enumerable: true, get: function () { return knowledge_2.KnowledgeService; } });
 class Quinn {
     config;
     http;
     organizations;
+    knowledge;
     members;
     roles;
     levels;
@@ -60,6 +66,7 @@ class Quinn {
                     orgId: this.config.orgId,
                 });
         this.organizations = new organizations_1.OrganizationsService(this.http, this.assertMutationAllowed);
+        this.knowledge = new knowledge_1.KnowledgeService(this.http);
         this.members = new members_1.MembersService(this.http, this.assertMutationAllowed);
         this.roles = new roles_1.RolesService(this.http);
         this.levels = new levels_1.LevelsService(this.http);

package/dist/services/knowledge.d.ts

@@ -0,0 +1,24 @@
+import { AxiosInstance } from 'axios';
+import { GetDocumentTranscriptResponse, KnowledgeDocument, KnowledgeDocumentsListQuery, KnowledgeFolder, KnowledgeFoldersListQuery, KnowledgeSearchHit, KnowledgeSearchInput, PagedResult } from '../types';
+export declare class KnowledgeDocumentsService {
+    private readonly http;
+    constructor(http: AxiosInstance);
+    list(query?: KnowledgeDocumentsListQuery): Promise<PagedResult<KnowledgeDocument>>;
+    get(id: string): Promise<KnowledgeDocument | null>;
+    getTranscript(id: string): Promise<GetDocumentTranscriptResponse>;
+}
+export declare class KnowledgeFoldersService {
+    private readonly http;
+    constructor(http: AxiosInstance);
+    list(query?: KnowledgeFoldersListQuery): Promise<{
+        items: KnowledgeFolder[];
+    }>;
+    get(id: string): Promise<KnowledgeFolder | null>;
+}
+export declare class KnowledgeService {
+    private readonly http;
+    readonly documents: KnowledgeDocumentsService;
+    readonly folders: KnowledgeFoldersService;
+    constructor(http: AxiosInstance);
+    search(input: KnowledgeSearchInput): Promise<KnowledgeSearchHit[]>;
+}

package/dist/services/knowledge.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KnowledgeService = exports.KnowledgeFoldersService = exports.KnowledgeDocumentsService = void 0;
+class KnowledgeDocumentsService {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    async list(query = {}) {
+        const resp = await this.http.get('/knowledge/documents', { params: query });
+        return resp.data;
+    }
+    async get(id) {
+        const resp = await this.http.get(`/knowledge/documents/${id}`);
+        return resp.data.item;
+    }
+    async getTranscript(id) {
+        const resp = await this.http.get(`/knowledge/documents/${id}/transcript`);
+        return resp.data;
+    }
+}
+exports.KnowledgeDocumentsService = KnowledgeDocumentsService;
+class KnowledgeFoldersService {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    async list(query = {}) {
+        const resp = await this.http.get('/knowledge/folders', { params: query });
+        return resp.data;
+    }
+    async get(id) {
+        const resp = await this.http.get(`/knowledge/folders/${id}`);
+        return resp.data.item;
+    }
+}
+exports.KnowledgeFoldersService = KnowledgeFoldersService;
+class KnowledgeService {
+    http;
+    documents;
+    folders;
+    constructor(http) {
+        this.http = http;
+        this.documents = new KnowledgeDocumentsService(http);
+        this.folders = new KnowledgeFoldersService(http);
+    }
+    async search(input) {
+        const resp = await this.http.post('/knowledge/search', input);
+        return resp.data.items;
+    }
+}
+exports.KnowledgeService = KnowledgeService;

package/dist/types.d.ts

@@ -122,6 +122,55 @@ export interface Course {
     creatorUid: string;
     createdAt: string;
 }
+export interface KnowledgeSearchInput {
+    query: string;
+    folderId?: string;
+    size?: number;
+}
+export interface KnowledgeSearchHit {
+    id: string;
+    type: string;
+    text: string;
+    metadata?: Record<string, unknown>;
+}
+export interface KnowledgeDocument {
+    id: string;
+    name: string;
+    uid: string;
+    orgId: string;
+    parentId: string;
+    parentType: string;
+    status: string;
+    extFileId: string | null;
+    contentType: string | null;
+    originalContentLength: number;
+    contentLength: number;
+    downloadable: boolean;
+    folderId: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface KnowledgeDocumentsListQuery extends PaginationQuery {
+    folderId?: string;
+    name?: string;
+    includePackFiles?: boolean;
+}
+export interface GetDocumentTranscriptResponse {
+    content: string;
+}
+export interface KnowledgeFolder {
+    id: string;
+    orgId: string;
+    name: string;
+    parentId: string | null;
+    createdBy: string;
+    children?: KnowledgeFolder[];
+    createdAt: string;
+    updatedAt: string;
+}
+export interface KnowledgeFoldersListQuery {
+    parentId?: string;
+}
 export interface Group {
     id: string;
     name: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@totoday/quinn-sdk",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [