@imbricate/core 1.5.4 → 1.6.0

package/collection/interface.d.ts

@@ -4,7 +4,7 @@
  * @description Interface
  */
 import { PromiseOr } from "../definition/promise";
-import { ImbricatePageMetadata, ImbricatePageSearchSnippet, ImbricatePageSnapshot } from "../page/definition";
+import { ImbricatePageMetadata, ImbricatePageSearchResult, ImbricatePageSnapshot } from "../page/definition";
 import { IImbricatePage } from "../page/interface";
 export interface IImbricateOriginCollection {
     readonly collectionName: string;
@@ -16,5 +16,5 @@ export interface IImbricateOriginCollection {
     hasPage(title: string): PromiseOr<boolean>;
     getPage(identifier: string): PromiseOr<IImbricatePage | null>;
     listPages(): PromiseOr<ImbricatePageSnapshot[]>;
-    searchPages(keyword: string): PromiseOr<ImbricatePageSearchSnippet[]>;
+    searchPages(keyword: string): PromiseOr<ImbricatePageSearchResult[]>;
 }

package/origin/definition.d.ts

@@ -3,8 +3,8 @@
  * @namespace Origin
  * @description Definition
  */
-import { IMBRICATE_SEARCH_SNIPPET_TYPE, ImbricateSearchSnippet } from "../search/snippet";
-export type ImbricateScriptSearchSnippet = ImbricateSearchSnippet<IMBRICATE_SEARCH_SNIPPET_TYPE.SCRIPT>;
+import { IMBRICATE_SEARCH_SNIPPET_TYPE, ImbricateSearchResult } from "../search/snippet";
+export type ImbricateScriptSearchResult = ImbricateSearchResult<IMBRICATE_SEARCH_SNIPPET_TYPE.SCRIPT>;
 export type ImbricateOriginMetadata = {
     readonly type: string;
 };

package/origin/interface.d.ts

@@ -7,7 +7,7 @@ import { IImbricateOriginCollection } from "../collection/interface";
 import { PromiseOr } from "../definition/promise";
 import { ImbricateScriptMetadata, ImbricateScriptSnapshot } from "../script/definition";
 import { IImbricateScript } from "../script/interface";
-import { ImbricateOriginMetadata, ImbricateScriptSearchSnippet } from "./definition";
+import { ImbricateOriginMetadata, ImbricateScriptSearchResult } from "./definition";
 export interface IImbricateOrigin {
     readonly metadata: ImbricateOriginMetadata;
     readonly payloads: Record<string, any>;
@@ -24,5 +24,5 @@ export interface IImbricateOrigin {
     hasScript(scriptName: string): PromiseOr<boolean>;
     getScript(identifier: string): PromiseOr<IImbricateScript | null>;
     listScripts(): PromiseOr<ImbricateScriptSnapshot[]>;
-    searchScripts(keyword: string): PromiseOr<ImbricateScriptSearchSnippet[]>;
+    searchScripts(keyword: string): PromiseOr<ImbricateScriptSearchResult[]>;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@imbricate/core",
   "main": "index.js",
-  "version": "1.5.4",
+  "version": "1.6.0",
   "description": "Core for Imbricate",
   "repository": {
     "type": "git",

package/page/definition.d.ts

@@ -3,8 +3,8 @@
  * @namespace Page
  * @description Definition
  */
-import { IMBRICATE_SEARCH_SNIPPET_TYPE, ImbricateSearchSnippet } from "../search/snippet";
-export type ImbricatePageSearchSnippet = ImbricateSearchSnippet<IMBRICATE_SEARCH_SNIPPET_TYPE.PAGE>;
+import { IMBRICATE_SEARCH_SNIPPET_TYPE, ImbricateSearchResult } from "../search/snippet";
+export type ImbricatePageSearchResult = ImbricateSearchResult<IMBRICATE_SEARCH_SNIPPET_TYPE.PAGE>;
 export type ImbricatePageSnapshot = {
     readonly title: string;
     readonly identifier: string;

package/search/prefix.d.ts

@@ -4,4 +4,4 @@
  * @description Prefix
  */
 import { IMBRICATE_SEARCH_SNIPPET_TYPE, ImbricateSearchSnippet } from "./snippet";
-export declare const getShortPrefixOfSnippet: (snippet: ImbricateSearchSnippet<IMBRICATE_SEARCH_SNIPPET_TYPE>) => string;
+export declare const getShortPrefixOfSnippet: <T extends IMBRICATE_SEARCH_SNIPPET_TYPE>(type: T, snippet: ImbricateSearchSnippet<T>) => string;

package/search/prefix.js

@@ -7,8 +7,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getShortPrefixOfSnippet = void 0;
 const snippet_1 = require("./snippet");
-const getShortPrefixOfSnippet = (snippet) => {
-    switch (snippet.type) {
+const getShortPrefixOfSnippet = (type, snippet) => {
+    switch (type) {
         case snippet_1.IMBRICATE_SEARCH_SNIPPET_TYPE.PAGE: {
             switch (snippet.source) {
                 case snippet_1.IMBRICATE_SEARCH_SNIPPET_PAGE_SNIPPET_SOURCE.TITLE: {
@@ -18,6 +18,18 @@ const getShortPrefixOfSnippet = (snippet) => {
                     return "C";
                 }
             }
+            break;
+        }
+        case snippet_1.IMBRICATE_SEARCH_SNIPPET_TYPE.SCRIPT: {
+            switch (snippet.source) {
+                case snippet_1.IMBRICATE_SEARCH_SNIPPET_SCRIPT_SNIPPET_SOURCE.NAME: {
+                    return "N";
+                }
+                case snippet_1.IMBRICATE_SEARCH_SNIPPET_SCRIPT_SNIPPET_SOURCE.SCRIPT: {
+                    return "D";
+                }
+            }
+            break;
         }
     }
     return "?";

package/search/snippet.d.ts

@@ -16,12 +16,17 @@ export declare enum IMBRICATE_SEARCH_SNIPPET_SCRIPT_SNIPPET_SOURCE {
     SCRIPT = "DESCRIPTION"
 }
 type IMBRICATE_SEARCH_SNIPPET_SNIPPET_SOURCE<T extends IMBRICATE_SEARCH_SNIPPET_TYPE> = T extends IMBRICATE_SEARCH_SNIPPET_TYPE.PAGE ? IMBRICATE_SEARCH_SNIPPET_PAGE_SNIPPET_SOURCE : T extends IMBRICATE_SEARCH_SNIPPET_TYPE.SCRIPT ? IMBRICATE_SEARCH_SNIPPET_SCRIPT_SNIPPET_SOURCE : never;
-export type ImbricateSearchSnippet<T extends IMBRICATE_SEARCH_SNIPPET_TYPE> = {
-    readonly type: T;
+type ImbricateSearchSnippetSwitch<T extends IMBRICATE_SEARCH_SNIPPET_TYPE> = T extends IMBRICATE_SEARCH_SNIPPET_TYPE.PAGE ? {
     readonly scope: string;
-    readonly identifier: string;
-    readonly headline: string;
+} : T extends IMBRICATE_SEARCH_SNIPPET_TYPE.SCRIPT ? {} : never;
+export type ImbricateSearchSnippet<T extends IMBRICATE_SEARCH_SNIPPET_TYPE> = {
     readonly source: IMBRICATE_SEARCH_SNIPPET_SNIPPET_SOURCE<T>;
     readonly snippet: string;
 };
+export type ImbricateSearchResult<T extends IMBRICATE_SEARCH_SNIPPET_TYPE> = {
+    readonly type: T;
+    readonly identifier: string;
+    readonly headline: string;
+    readonly snippets: ImbricateSearchSnippet<T>[];
+} & ImbricateSearchSnippetSwitch<T>;
 export {};