@edifice.io/aiwiki-v2-node-api 0.0.0-stage → 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './nats/types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC"}

package/dist/index.js

@@ -0,0 +1 @@
+

package/dist/index.umd.cjs

@@ -0,0 +1 @@
+(function(n){typeof define=="function"&&define.amd?define(n):n()})(function(){"use strict"});

package/dist/nats/types.d.ts

@@ -0,0 +1,371 @@
+/**
+ * Request of the generation of a wiki from a description of its subject.
+ */
+export interface ContentRequest {
+    /**
+     * User agent of the browser of the user.
+     */
+    browser?: string;
+    /**
+     * Description of the expected content.
+     */
+    content?: string;
+    /**
+     * Keywords of the wiki.
+     */
+    keywords?: string;
+    /**
+     * School level of the audience.
+     */
+    level?: string;
+    /**
+     * Identifier of the platform, to which the generated wiki is sent back.
+     */
+    pf_id?: string;
+    /**
+     * Session of the user.
+     */
+    session?: string;
+    /**
+     * Subject of the wiki.
+     */
+    subject?: string;
+    /**
+     * Identifier of the user who asked for the generation.
+     */
+    user_id?: string;
+    /**
+     * Identifier of the wiki to fill.
+     */
+    wiki_id?: string;
+}
+/**
+ * Request of the generation of a wiki from a PDF.
+ */
+export interface ContentTransformRequest {
+    /**
+     * User agent of the browser of the user.
+     */
+    browser?: string;
+    /**
+     * Path of the PDF in the storage of the generator.
+     */
+    path_file?: string;
+    /**
+     * Identifier of the platform, to which the generated wiki is sent back.
+     */
+    pf_id?: string;
+    /**
+     * Session of the user.
+     */
+    session?: string;
+    /**
+     * Identifier of the user who asked for the generation.
+     */
+    user_id?: string;
+    /**
+     * Identifier of the wiki to fill.
+     */
+    wiki_id?: string;
+}
+/**
+ * A generated wiki.
+ */
+export interface Course {
+    /**
+     * Creation date, ISO 8601.
+     */
+    created?: string;
+    description?: string;
+    /**
+     * Modification date, ISO 8601.
+     */
+    modified?: string;
+    /**
+     * Owner of the wiki.
+     */
+    owner?: Owner;
+    /**
+     * Pages of the wiki.
+     */
+    pages?: Page[];
+    /**
+     * Thumbnail of the wiki.
+     */
+    thumbnail?: string;
+    title?: string;
+}
+/**
+ * Structure of a generated wiki.
+ */
+export interface CourseHierarchy {
+    /**
+     * Whether the wiki is generated from a PDF.
+     *
+     * @defaultValue `false`
+     */
+    fromPdf?: boolean;
+    /**
+     * Pages of the wiki, without their content.
+     */
+    pages?: PageStructure[];
+    /**
+     * Identifier of the wiki.
+     */
+    wiki_id?: string;
+}
+/**
+ * A generated page of a wiki, with the wiki it belongs to.
+ */
+export interface CourseResponse {
+    /**
+     * The wiki, holding the generated page only.
+     */
+    course?: Course;
+    /**
+     * Whether the wiki is generated from a PDF : its images are then to be copied from the storage of the generator.
+     *
+     * @defaultValue `false`
+     */
+    fromPdf?: boolean;
+    /**
+     * Message describing the status.
+     *
+     * @defaultValue `"Course has been successfully generated."`
+     */
+    message?: string;
+    /**
+     * Model that generated the page.
+     */
+    model?: string;
+    /**
+     * Status of the generation : `success` or `error`.
+     *
+     * @defaultValue `"success"`
+     */
+    status?: string;
+    /**
+     * Tokens used by the generation.
+     */
+    usage?: Usage;
+    /**
+     * Version of the generator.
+     */
+    version?: string;
+    /**
+     * Identifier of the wiki.
+     */
+    wiki_id?: string;
+}
+/**
+ * Request of the check of a PDF.
+ */
+export interface FileCheckRequest {
+    /**
+     * Path of the PDF in the storage of the generator.
+     */
+    path_file?: string;
+    /**
+     * Identifier of the platform.
+     */
+    pf_id?: string;
+    /**
+     * Identifier of the user who asked for the check.
+     */
+    user_id?: string;
+}
+/**
+ * Result of the check of a PDF.
+ */
+export interface FileCheckResponse {
+    /**
+     * Why the PDF cannot be used.
+     */
+    reason?: string;
+    /**
+     * Numbers of the pages that are left out.
+     *
+     * @defaultValue `[]`
+     */
+    skipped_pages?: number[];
+    /**
+     * Number of pages of the PDF.
+     *
+     * @defaultValue `0`
+     */
+    total_pages?: number;
+    /**
+     * Whether the PDF can be turned into a wiki.
+     */
+    usable?: boolean;
+    /**
+     * Numbers of the pages that are used.
+     *
+     * @defaultValue `[]`
+     */
+    usable_pages?: number[];
+}
+/**
+ * Acknowledgement of a generation job.
+ */
+export interface JobAccepted {
+    /**
+     * Whether the job was started.
+     */
+    accepted?: boolean;
+    /**
+     * Why the job was refused.
+     */
+    reason?: string;
+}
+/**
+ * Content of a page, in the JSON of the editor.
+ */
+export interface JsonContent {
+    content?: JsonContentItem[];
+    /**
+     * Type of the root node, `doc`.
+     *
+     * @defaultValue `"doc"`
+     */
+    type?: string;
+}
+/**
+ * A node of the JSON of the editor.
+ */
+export interface JsonContentItem {
+    /**
+     * Attributes of the node.
+     */
+    attrs?: object;
+    /**
+     * Children of the node, kept as free JSON.
+     */
+    content?: any[];
+    type?: string;
+}
+/**
+ * Acknowledgement of a generated part of a wiki, by the wiki application.
+ */
+export interface MessageReceived {
+    /**
+     * Why the part could not be saved.
+     */
+    reason?: string;
+    /**
+     * Whether the part was saved.
+     */
+    received?: boolean;
+}
+/**
+ * Owner of a wiki.
+ */
+export interface Owner {
+    displayName?: string;
+    userId?: string;
+}
+/**
+ * A generated page of a wiki.
+ */
+export interface Page {
+    /**
+     * Identifier of the author.
+     */
+    author?: string;
+    authorName?: string;
+    /**
+     * Content of the page, in HTML.
+     */
+    content?: string;
+    /**
+     * Version of the format of the content.
+     */
+    contentVersion?: number;
+    /**
+     * Creation date, ISO 8601.
+     */
+    created?: string;
+    /**
+     * Images of the page, in the storage of the generator.
+     *
+     * @defaultValue `[]`
+     */
+    images?: PageImage[];
+    isVisible?: boolean;
+    /**
+     * Content of the page, in the JSON of the editor.
+     */
+    jsonContent?: JsonContent;
+    /**
+     * Identifier of the last contributor.
+     */
+    lastContributer?: string;
+    lastContributerName?: string;
+    /**
+     * Modification date, ISO 8601.
+     */
+    modified?: string;
+    /**
+     * Position of the page in the wiki.
+     */
+    position?: number;
+    title?: string;
+}
+/**
+ * An image of a generated page.
+ */
+export interface PageImage {
+    contentType?: string;
+    /**
+     * Identifier of the image in the storage of the generator.
+     */
+    id?: string;
+    /**
+     * @defaultValue `""`
+     */
+    name?: string;
+    /**
+     * Size in bytes.
+     */
+    size?: number;
+    /**
+     * URL of the image in the content of the page.
+     */
+    url?: string;
+}
+/**
+ * A page of the structure of a generated wiki.
+ */
+export interface PageStructure {
+    /**
+     * Whether the page is the main page of the wiki.
+     *
+     * @defaultValue `true`
+     */
+    is_main_page?: boolean;
+    /**
+     * Parent page, when the page is a sub page.
+     */
+    parent_id?: string;
+    /**
+     * Position of the page in the wiki.
+     */
+    position?: number;
+    /**
+     * Theme of the page.
+     */
+    theme?: string;
+    /**
+     * Title of the page.
+     */
+    title?: string;
+}
+/**
+ * Tokens used by a generation.
+ */
+export interface Usage {
+    completion_tokens?: number;
+    prompt_tokens?: number;
+    total_tokens?: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/nats/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/nats/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;IACf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC;IAC5B;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB"}

package/package.json

@@ -1,6 +1,58 @@
 {
   "name": "@edifice.io/aiwiki-v2-node-api",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "Clients to interact with aiwiki-v2-nats-service",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [],
+  "author": "Edifice",
+  "license": "AGPL-3.0",
+  "engines": {
+    "node": "22"
+  },
+  "engineStrict": true,
+  "type": "module",
+  "exports": {
+    ".": {
+      "require": "./dist/index.umd.cjs",
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "main": "dist/index.umd.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@nats-io/transport-node": "3.2.0",
+    "@nats-io/nats-core": "3.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "25.2.0",
+    "husky": "9.0.11",
+    "prettier": "3.2.5",
+    "semantic-release": "23.0.2",
+    "typescript": "5.2.2",
+    "vite": "5.1.4",
+    "vite-plugin-dts": "4.3.0",
+    "rxjs": "7.8.1"
+  },
+  "lint-staged": {
+    "*.{js,ts,jsx,tsx,json,css,md}": "pnpm format"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "build:types": "tsc --build",
+    "preview": "vite preview",
+    "clean": "rm -Rf dist",
+    "format": "pnpm run format:write && pnpm run format:check",
+    "format:check": "npx prettier --check \"src/**/*.ts\"",
+    "format:write": "npx prettier --write \"src/**/*.ts\"",
+    "pre-commit": "pnpm run format"
+  }
 }

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.