@pc-nexus/models 0.0.1-next.1 → 0.0.1-next.2

package/fesm2022/pc-nexus-models.mjs

@@ -1,7 +1,7 @@
 var NexusAppEnvironment;
 (function (NexusAppEnvironment) {
-    NexusAppEnvironment["Development"] = "development";
-    NexusAppEnvironment["Production"] = "production";
+    NexusAppEnvironment["development"] = "development";
+    NexusAppEnvironment["production"] = "production";
 })(NexusAppEnvironment || (NexusAppEnvironment = {}));
 
 const SUPPORTED_LOCALE_CODES = ["zh-cn", "en-us"];
@@ -20,6 +20,21 @@ var ViewportSize;
     ViewportSize["max"] = "max";
 })(ViewportSize || (ViewportSize = {}));
 
+var NotifyType;
+(function (NotifyType) {
+    NotifyType["success"] = "success";
+    NotifyType["error"] = "error";
+    NotifyType["warning"] = "warning";
+    NotifyType["info"] = "info";
+})(NotifyType || (NotifyType = {}));
+
+var HistoryAction;
+(function (HistoryAction) {
+    HistoryAction["pop"] = "POP";
+    HistoryAction["push"] = "PUSH";
+    HistoryAction["replace"] = "REPLACE";
+})(HistoryAction || (HistoryAction = {}));
+
 /*
  * Public API Surface of models
  */
@@ -28,5 +43,5 @@ var ViewportSize;
  * Generated bundle index. Do not edit.
  */
 
-export { NavigationTarget, NexusAppEnvironment, SUPPORTED_LOCALE_CODES, ViewportSize };
+export { HistoryAction, NavigationTarget, NexusAppEnvironment, NotifyType, SUPPORTED_LOCALE_CODES, ViewportSize };
 //# sourceMappingURL=pc-nexus-models.mjs.map

package/fesm2022/pc-nexus-models.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"pc-nexus-models.mjs","sources":["../../../../web/models/src/environment.ts","../../../../web/models/src/locale.ts","../../../../web/models/src/navigation.ts","../../../../web/models/src/viewport.ts","../../../../web/models/src/public-api.ts","../../../../web/models/src/pc-nexus-models.ts"],"sourcesContent":["export enum NexusAppEnvironment {\n    Development = \"development\",\n    Production = \"production\",\n}\n","export const SUPPORTED_LOCALE_CODES = [\"zh-cn\", \"en-us\"] as const;\n\nexport type NexusSupportedLocaleCode = (typeof SUPPORTED_LOCALE_CODES)[number];\n\nexport interface Translator {\n    translate: (key: string, params?: Record<string, any>) => string;\n}\nexport interface GetTranslationsResult {\n    locale: NexusSupportedLocaleCode;\n    translations: TranslationResourceContent | null;\n}\n\nexport interface TranslationResourceContent {\n    [key: string]: string | TranslationResourceContent;\n}\n","export enum NavigationTarget {\n    workItem = \"workItem\",\n}\n\nexport interface NavigationWorkItem {\n    target: NavigationTarget.workItem;\n    workItemId: string;\n}\n\nexport type NavigationLocation = NavigationWorkItem;\n\nexport interface NavigatePayload {\n    url?: string;\n    location?: NavigationLocation;\n}\n","export interface Viewport {\n    size?: ViewportSize;\n}\n\nexport enum ViewportSize {\n    small = \"small\",\n    medium = \"medium\",\n    large = \"large\",\n    xlarge = \"xlarge\",\n    max = \"max\",\n}\n","/*\n * Public API Surface of models\n */\n\nexport * from \"./context\";\nexport * from \"./dialog\";\nexport * from \"./environment\";\nexport * from \"./extension\";\nexport * from \"./invoke\";\nexport * from \"./locale\";\nexport * from \"./navigation\";\nexport * from \"./viewport\";\nexport * from \"./events\";\nexport * from \"./work-item\";\nexport * from \"./user\";\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './public-api';\n"],"names":[],"mappings":"IAAY;AAAZ,CAAA,UAAY,mBAAmB,EAAA;AAC3B,IAAA,mBAAA,CAAA,aAAA,CAAA,GAAA,aAA2B;AAC3B,IAAA,mBAAA,CAAA,YAAA,CAAA,GAAA,YAAyB;AAC7B,CAAC,EAHW,mBAAmB,KAAnB,mBAAmB,GAAA,EAAA,CAAA,CAAA;;MCAlB,sBAAsB,GAAG,CAAC,OAAO,EAAE,OAAO;;ICA3C;AAAZ,CAAA,UAAY,gBAAgB,EAAA;AACxB,IAAA,gBAAA,CAAA,UAAA,CAAA,GAAA,UAAqB;AACzB,CAAC,EAFW,gBAAgB,KAAhB,gBAAgB,GAAA,EAAA,CAAA,CAAA;;ICIhB;AAAZ,CAAA,UAAY,YAAY,EAAA;AACpB,IAAA,YAAA,CAAA,OAAA,CAAA,GAAA,OAAe;AACf,IAAA,YAAA,CAAA,QAAA,CAAA,GAAA,QAAiB;AACjB,IAAA,YAAA,CAAA,OAAA,CAAA,GAAA,OAAe;AACf,IAAA,YAAA,CAAA,QAAA,CAAA,GAAA,QAAiB;AACjB,IAAA,YAAA,CAAA,KAAA,CAAA,GAAA,KAAW;AACf,CAAC,EANW,YAAY,KAAZ,YAAY,GAAA,EAAA,CAAA,CAAA;;ACJxB;;AAEG;;ACFH;;AAEG;;;;"}
+{"version":3,"file":"pc-nexus-models.mjs","sources":["../../../../web/models/src/environment.ts","../../../../web/models/src/locale.ts","../../../../web/models/src/navigation.ts","../../../../web/models/src/viewport.ts","../../../../web/models/src/notify.ts","../../../../web/models/src/view.ts","../../../../web/models/src/public-api.ts","../../../../web/models/src/pc-nexus-models.ts"],"sourcesContent":["export enum NexusAppEnvironment {\n    development = \"development\",\n    production = \"production\",\n}\n","export const SUPPORTED_LOCALE_CODES = [\"zh-cn\", \"en-us\"] as const;\n\nexport type NexusSupportedLocaleCode = (typeof SUPPORTED_LOCALE_CODES)[number];\n\nexport interface Translator {\n    translate: (key: string, params?: Record<string, any>) => string;\n}\nexport interface GetTranslationsResult {\n    locale: NexusSupportedLocaleCode;\n    translations: TranslationResourceContent | null;\n}\n\nexport interface TranslationResourceContent {\n    [key: string]: string | TranslationResourceContent;\n}\n","export enum NavigationTarget {\n    workItem = \"workItem\",\n}\n\ninterface NavigationWorkItem {\n    target: NavigationTarget.workItem;\n    workItemId: string;\n}\n\nexport type NavigationLocation = NavigationWorkItem;\n","export interface Viewport {\n    size?: ViewportSize;\n}\n\nexport enum ViewportSize {\n    small = \"small\",\n    medium = \"medium\",\n    large = \"large\",\n    xlarge = \"xlarge\",\n    max = \"max\",\n}\n","export enum NotifyType {\n    success = \"success\",\n    error = \"error\",\n    warning = \"warning\",\n    info = \"info\",\n}\n\nexport interface NotifyOptions {\n    type?: NotifyType;\n    title?: string;\n    description?: string;\n    detail?: string | NotifyDetail;\n    actions?: NotifyAction[];\n    isAutoClose?: boolean;\n}\n\nexport interface NotifyRef {\n    close: () => void;\n}\n\nexport interface NotifyDetail {\n    link?: string;\n    content?: string;\n}\n\nexport interface NotifyAction {\n    text: string;\n    icon?: string;\n    onClick: (event?: Event) => void;\n}\n","export enum HistoryAction {\n    pop = \"POP\",\n    push = \"PUSH\",\n    replace = \"REPLACE\",\n}\n\nexport interface LocationDescriptor {\n    pathname: string;\n    search?: string;\n    hash?: string;\n    state?: unknown;\n}\n\nexport type UnlistenCallback = () => void;\n\nexport interface NexusHistory {\n    action: HistoryAction;\n    location: LocationDescriptor;\n    push(path: string, state?: unknown): void;\n    push(location: LocationDescriptor): void;\n    replace(path: string, state?: unknown): void;\n    replace(location: LocationDescriptor): void;\n    go(n: number): void;\n    goBack(): void;\n    goForward(): void;\n    listen(listener: (location: LocationDescriptor, action: HistoryAction) => void): Promise<UnlistenCallback>;\n}\n","/*\n * Public API Surface of models\n */\n\nexport * from \"./context\";\nexport * from \"./dialog\";\nexport * from \"./environment\";\nexport * from \"./extension\";\nexport * from \"./invoke\";\nexport * from \"./locale\";\nexport * from \"./navigation\";\nexport * from \"./viewport\";\nexport * from \"./events\";\nexport * from \"./work-item\";\nexport * from \"./user\";\nexport * from \"./request-api\";\nexport * from \"./notify\";\nexport * from \"./view\";\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './public-api';\n"],"names":[],"mappings":"IAAY;AAAZ,CAAA,UAAY,mBAAmB,EAAA;AAC3B,IAAA,mBAAA,CAAA,aAAA,CAAA,GAAA,aAA2B;AAC3B,IAAA,mBAAA,CAAA,YAAA,CAAA,GAAA,YAAyB;AAC7B,CAAC,EAHW,mBAAmB,KAAnB,mBAAmB,GAAA,EAAA,CAAA,CAAA;;MCAlB,sBAAsB,GAAG,CAAC,OAAO,EAAE,OAAO;;ICA3C;AAAZ,CAAA,UAAY,gBAAgB,EAAA;AACxB,IAAA,gBAAA,CAAA,UAAA,CAAA,GAAA,UAAqB;AACzB,CAAC,EAFW,gBAAgB,KAAhB,gBAAgB,GAAA,EAAA,CAAA,CAAA;;ICIhB;AAAZ,CAAA,UAAY,YAAY,EAAA;AACpB,IAAA,YAAA,CAAA,OAAA,CAAA,GAAA,OAAe;AACf,IAAA,YAAA,CAAA,QAAA,CAAA,GAAA,QAAiB;AACjB,IAAA,YAAA,CAAA,OAAA,CAAA,GAAA,OAAe;AACf,IAAA,YAAA,CAAA,QAAA,CAAA,GAAA,QAAiB;AACjB,IAAA,YAAA,CAAA,KAAA,CAAA,GAAA,KAAW;AACf,CAAC,EANW,YAAY,KAAZ,YAAY,GAAA,EAAA,CAAA,CAAA;;ICJZ;AAAZ,CAAA,UAAY,UAAU,EAAA;AAClB,IAAA,UAAA,CAAA,SAAA,CAAA,GAAA,SAAmB;AACnB,IAAA,UAAA,CAAA,OAAA,CAAA,GAAA,OAAe;AACf,IAAA,UAAA,CAAA,SAAA,CAAA,GAAA,SAAmB;AACnB,IAAA,UAAA,CAAA,MAAA,CAAA,GAAA,MAAa;AACjB,CAAC,EALW,UAAU,KAAV,UAAU,GAAA,EAAA,CAAA,CAAA;;ICAV;AAAZ,CAAA,UAAY,aAAa,EAAA;AACrB,IAAA,aAAA,CAAA,KAAA,CAAA,GAAA,KAAW;AACX,IAAA,aAAA,CAAA,MAAA,CAAA,GAAA,MAAa;AACb,IAAA,aAAA,CAAA,SAAA,CAAA,GAAA,SAAmB;AACvB,CAAC,EAJW,aAAa,KAAb,aAAa,GAAA,EAAA,CAAA,CAAA;;ACAzB;;AAEG;;ACFH;;AAEG;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pc-nexus/models",
-  "version": "0.0.1-next.1",
+  "version": "0.0.1-next.2",
   "peerDependencies": {},
   "dependencies": {
     "tslib": "^2.3.0"
@@ -17,4 +17,4 @@
       "default": "./fesm2022/pc-nexus-models.mjs"
     }
   }
-}
+}

package/types/pc-nexus-models.d.ts

@@ -1,6 +1,6 @@
 declare enum NexusAppEnvironment {
-    Development = "development",
-    Production = "production"
+    development = "development",
+    production = "production"
 }
 
 declare const SUPPORTED_LOCALE_CODES: readonly ["zh-cn", "en-us"];
@@ -96,10 +96,6 @@ interface NavigationWorkItem {
     workItemId: string;
 }
 type NavigationLocation = NavigationWorkItem;
-interface NavigatePayload {
-    url?: string;
-    location?: NavigationLocation;
-}
 
 interface EventCallbackParams {
     payload?: any;
@@ -138,15 +134,78 @@ interface SelectMemberDialogOptions {
     selection?: string[];
     onConfirm?: (payload?: string[]) => Promise<void>;
 }
-type SelectMemberPopOptions = {
-    multiple?: true;
+interface SelectMemberPopBaseOptions {
+    origin: HTMLElement;
+}
+interface MultipleSelectOptions extends SelectMemberPopBaseOptions {
+    multiple: true;
     selection?: string[];
-    onConfirm?: (payload?: string[]) => Promise<void>;
-} | {
+    onConfirm?: (ids?: string[]) => Promise<void>;
+}
+interface SingleSelectOptions extends SelectMemberPopBaseOptions {
     multiple?: false;
     selection?: string;
-    onConfirm?: (payload?: string) => Promise<void>;
-};
+    onConfirm?: (id?: string) => Promise<void>;
+}
+type SelectMemberPopOptions = MultipleSelectOptions | SingleSelectOptions;
+
+interface RequestApiResponseData {
+    status: number;
+    headers?: Record<string, string>;
+    body?: Record<string, any>;
+}
+
+declare enum NotifyType {
+    success = "success",
+    error = "error",
+    warning = "warning",
+    info = "info"
+}
+interface NotifyOptions {
+    type?: NotifyType;
+    title?: string;
+    description?: string;
+    detail?: string | NotifyDetail;
+    actions?: NotifyAction[];
+    isAutoClose?: boolean;
+}
+interface NotifyRef {
+    close: () => void;
+}
+interface NotifyDetail {
+    link?: string;
+    content?: string;
+}
+interface NotifyAction {
+    text: string;
+    icon?: string;
+    onClick: (event?: Event) => void;
+}
+
+declare enum HistoryAction {
+    pop = "POP",
+    push = "PUSH",
+    replace = "REPLACE"
+}
+interface LocationDescriptor {
+    pathname: string;
+    search?: string;
+    hash?: string;
+    state?: unknown;
+}
+type UnlistenCallback = () => void;
+interface NexusHistory {
+    action: HistoryAction;
+    location: LocationDescriptor;
+    push(path: string, state?: unknown): void;
+    push(location: LocationDescriptor): void;
+    replace(path: string, state?: unknown): void;
+    replace(location: LocationDescriptor): void;
+    go(n: number): void;
+    goBack(): void;
+    goForward(): void;
+    listen(listener: (location: LocationDescriptor, action: HistoryAction) => void): Promise<UnlistenCallback>;
+}
 
-export { NavigationTarget, NexusAppEnvironment, SUPPORTED_LOCALE_CODES, ViewportSize };
-export type { DialogOptions, DialogRef, EgressItem, EventCallbackParams, EventCallbackType, EventEmitParams, EventOnParams, ExtensionData, ExtensionProperties, GetTranslationsResult, InvokeFunctionParams, NavigatePayload, NavigationLocation, NavigationWorkItem, NexusAppExtension, NexusFullContext, NexusSupportedLocaleCode, SelectMemberDialogOptions, SelectMemberPopOptions, Subscription, TranslationResourceContent, Translator, Viewport, WorkItemOpenCreateOptions };
+export { HistoryAction, NavigationTarget, NexusAppEnvironment, NotifyType, SUPPORTED_LOCALE_CODES, ViewportSize };
+export type { DialogOptions, DialogRef, EgressItem, EventCallbackParams, EventCallbackType, EventEmitParams, EventOnParams, ExtensionData, ExtensionProperties, GetTranslationsResult, InvokeFunctionParams, LocationDescriptor, MultipleSelectOptions, NavigationLocation, NexusAppExtension, NexusFullContext, NexusHistory, NexusSupportedLocaleCode, NotifyAction, NotifyDetail, NotifyOptions, NotifyRef, RequestApiResponseData, SelectMemberDialogOptions, SelectMemberPopOptions, SingleSelectOptions, Subscription, TranslationResourceContent, Translator, UnlistenCallback, Viewport, WorkItemOpenCreateOptions };