@synopackageland/sdk 0.0.0-stage → 0.9.1

package/dist/src/authorization/AuthorizationGate.vue.d.ts

@@ -0,0 +1,22 @@
+import type { Context } from '../context';
+type __VLS_Props = {
+    ctx: Pick<Context, 'locale' | 'displayName' | 'reopen' | 'authorization'>;
+    name?: string;
+};
+declare var __VLS_53: {};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_53) => any;
+};
+declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    ready: () => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onReady?: (() => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/src/authorization/i18n.d.ts

@@ -0,0 +1,3 @@
+export declare const authorizationCatalogs: Record<string, Record<string, string>>;
+/** Root-task semantics are owned by the native product. */
+export declare function authorizationCopy(locale: string, packageName: string): (key: string) => string;

package/dist/src/background/BackgroundPanel.vue.d.ts

@@ -0,0 +1,7 @@
+import type { Context } from '../context';
+type __VLS_Props = {
+    ctx: Pick<Context, 'call' | 'locale'>;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/src/background/i18n.d.ts

@@ -0,0 +1,79 @@
+import en from '../../i18n/background/en.json';
+export type BackgroundCopy = typeof en;
+export declare const backgroundCatalogs: Record<import("..").UiLocale, {
+    title: string;
+    help: string;
+    worker: string;
+    workerRunning: string;
+    workerStopped: string;
+    chooseFile: string;
+    chosen: string;
+    pickerTitle: string;
+    pickerConsent: string;
+    submit: string;
+    refresh: string;
+    cancel: string;
+    result: string;
+    download: string;
+    noJobs: string;
+    state_queued: string;
+    state_running: string;
+    state_succeeded: string;
+    state_failed: string;
+    state_canceled: string;
+    state_interrupted: string;
+    limits: string;
+    errors: {
+        jobs_busy: string;
+        failed: string;
+        "limit-exceeded": string;
+        "queue-full": string;
+        "quota-exceeded": string;
+        conflict: string;
+        not_found: string;
+        denied: string;
+        session_required: string;
+        "owner-queue-full": string;
+        "owner-quota-exceeded": string;
+        identity_unavailable: string;
+        "schedule-full": string;
+        "input-unavailable": string;
+        unsupported: string;
+    };
+    ownerScope: string;
+    adminScope: string;
+    ownerLimits: string;
+    owner: string;
+    purgeOwner: string;
+    purgeConfirm: string;
+    confirmPurge: string;
+    keepJobs: string;
+    schedulesTitle: string;
+    scheduleHelp: string;
+    scheduleCopy: string;
+    scheduleSource: string;
+    interval: string;
+    hourly: string;
+    daily: string;
+    weekly: string;
+    scheduleConsent: string;
+    createSchedule: string;
+    noSchedules: string;
+    scheduleOn: string;
+    scheduleOff: string;
+    nextRun: string;
+    missedRuns: string;
+    disableSchedule: string;
+    deleteSchedule: string;
+    deleteScheduleConsent: string;
+    confirmDeleteSchedule: string;
+    enableSchedule: string;
+    enableScheduleConsent: string;
+    confirmEnableSchedule: string;
+    revisionChanged: string;
+    scheduledJob: string;
+    unknownTime: string;
+    unsupported: string;
+}>;
+export declare function backgroundCopy(locale: string): BackgroundCopy;
+export declare function backgroundErrorCopy(e: unknown, copy: BackgroundCopy): string;

package/dist/src/background/picker-provider.d.ts

@@ -0,0 +1,3 @@
+import type { Context } from '../context';
+import type { NasProvider } from '../nas/contract';
+export declare function createBackgroundPickerProvider(ctx: Pick<Context, 'call'>): NasProvider;

package/dist/src/background/request-key.d.ts

@@ -0,0 +1 @@
+export declare function requestKey(): string;

package/dist/src/context.d.ts

@@ -0,0 +1,114 @@
+export interface HostPlatformSnapshot {
+    readonly web: boolean;
+    readonly host: 'dsm' | 'standalone-web' | 'unavailable';
+    readonly dsmStandalone: boolean | null;
+    readonly dsmLanguage: string | null;
+    readonly appLocale: string | null;
+    readonly systemVersion: string | null;
+    readonly fullVersion: string | null;
+    readonly theme: null;
+}
+export type HostTitleResult = {
+    status: 'ok';
+    target: 'dsm-window' | 'document';
+} | {
+    status: 'unsupported' | 'unavailable' | 'invalid-input' | 'failed';
+};
+export type HostRequestResult = {
+    status: 'requested';
+} | {
+    status: 'unsupported' | 'unavailable' | 'invalid-input' | 'blocked' | 'failed';
+};
+export type HostURLResult = {
+    status: 'requested';
+    windowHandleAvailable: boolean;
+} | {
+    status: 'unsupported' | 'unavailable' | 'invalid-input' | 'failed';
+};
+export type HostEvent = 'window-resize' | 'host-theme-change' | 'host-language-change';
+export type HostSubscriptionResult = {
+    status: 'subscribed';
+    dispose(): void;
+} | {
+    status: 'unsupported' | 'unavailable' | 'invalid-input' | 'failed';
+};
+export type HostFileNavigationResult = {
+    status: 'requested';
+    action: 'locate-folder' | 'highlight-file';
+} | {
+    status: 'unsupported' | 'unavailable' | 'invalid-input' | 'failed';
+};
+export type HostUnsupportedResult = {
+    status: 'unsupported' | 'unavailable';
+};
+export interface HostAdapter {
+    platform(): HostPlatformSnapshot;
+    setTitle(title: string): HostTitleResult;
+    activateWindow(): HostRequestResult;
+    requestClose(): HostRequestResult;
+    openApp(appId: string): HostRequestResult;
+    openURL(url: string): HostURLResult;
+    openFileManager(path: string): HostFileNavigationResult;
+    revealFile(path: string): HostFileNavigationResult;
+    openFile(path: string): HostUnsupportedResult;
+    showFileDetails(paths: readonly string[]): HostUnsupportedResult;
+    openAppSetting(): HostUnsupportedResult;
+    subscribe(event: HostEvent, listener: () => void): HostSubscriptionResult;
+    dispose(): void;
+}
+export interface PortalStatus {
+    state: 'active' | 'inactive' | 'unavailable';
+    alias?: string;
+    url?: string;
+    canManage: boolean;
+    controlPanel: boolean;
+    defaultAlias: string;
+}
+export interface PortalAccess {
+    messages: Record<string, string>;
+    status(): Promise<PortalStatus>;
+    apply(alias: string): Promise<PortalStatus>;
+    disable(): Promise<PortalStatus>;
+    openControlPanel(): void;
+    mountPanel(element: HTMLElement): {
+        refresh(): Promise<void>;
+        dispose(): void;
+    };
+}
+export interface AuthorizationStatus {
+    command: 'authorization';
+    schema_version: 1;
+    state: 'ready' | 'authorization_required' | 'not_admin' | 'session_expired' | 'unavailable';
+    reason?: string | null;
+}
+export interface AuthorizationAccess {
+    canManage(): boolean;
+    status(): Promise<AuthorizationStatus>;
+    request(): Promise<AuthorizationStatus>;
+    revoke(): Promise<AuthorizationStatus>;
+}
+export interface Context {
+    authorization?: AuthorizationAccess;
+    delegate?: import('./delegate/long-running').BackgroundSaveFacade;
+    files?: {
+        endpoint: string;
+        token?: () => string | undefined;
+    };
+    displayName?: string;
+    executor?: import('./delegate/executor-setup').ExecutorSetup;
+    user?: {
+        readonly name: string;
+        readonly isAdmin: boolean;
+    };
+    portal?: PortalAccess;
+    call<T = unknown>(method: string, params?: Record<string, unknown>): Promise<T>;
+    reopen(fn: () => void): () => void;
+    locale: string;
+    host: HostAdapter;
+}
+export interface AppStatus {
+    package: string;
+    version: string;
+    user: string;
+    admin: boolean;
+}

package/dist/src/delegate/BackgroundSavePanel.vue.d.ts

@@ -0,0 +1,18 @@
+import type { BackgroundSaveFacade, DestinationGrant } from './long-running';
+import type { NasProvider } from '../nas/contract';
+type __VLS_Props = {
+    sdk: BackgroundSaveFacade;
+    admin: boolean;
+    locale: string;
+    picker?: {
+        provider: NasProvider;
+        keys: string[];
+    };
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    authorized: (grant: DestinationGrant) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onAuthorized?: ((grant: DestinationGrant) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/src/delegate/DelegatePanel.vue.d.ts

@@ -0,0 +1,7 @@
+import type { Context } from '../context';
+type __VLS_Props = {
+    ctx: Pick<Context, 'call' | 'locale'>;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/src/delegate/ExecutorSettings.vue.d.ts

@@ -0,0 +1,13 @@
+import type { Context } from '../context';
+type __VLS_Props = {
+    admin: boolean;
+    locale?: string;
+    ctx?: Pick<Context, 'call'>;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    confirmed: () => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onConfirmed?: (() => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/src/delegate/copy.d.ts

@@ -0,0 +1,101 @@
+import en from '../../i18n/delegate/en.json';
+export type DelegateCopy = typeof en;
+export declare const delegateCatalogs: Record<import("..").UiLocale, {
+    title: string;
+    help: string;
+    setupTitle: string;
+    setupHelp: string;
+    password: string;
+    authorize: string;
+    confirmShare: string;
+    scopeNeeds: string;
+    ready: string;
+    needs: string;
+    blocked: string;
+    loading: string;
+    details: string;
+    refresh: string;
+    revoke: string;
+    cancel: string;
+    noDelegations: string;
+    delegations: string;
+    expires: string;
+    downloads: string;
+    noJobs: string;
+    url: string;
+    name: string;
+    choose: string;
+    submit: string;
+    destination: string;
+    pending: string;
+    error: string;
+    setupError: string;
+    denied: string;
+    session: string;
+    size: string;
+    queued: string;
+    running: string;
+    succeeded: string;
+    failed: string;
+    canceled: string;
+    interrupted: string;
+    homeScope: string;
+    scopeLabel: string;
+    protectedScope: string;
+    preselection: string;
+    preselectionHelp: string;
+    scopeMismatch: string;
+    scopeChangeHelp: string;
+    confirmScope: string;
+    waiting_executor: string;
+}>;
+export declare function delegateCopy(locale?: string): {
+    title: string;
+    help: string;
+    setupTitle: string;
+    setupHelp: string;
+    password: string;
+    authorize: string;
+    confirmShare: string;
+    scopeNeeds: string;
+    ready: string;
+    needs: string;
+    blocked: string;
+    loading: string;
+    details: string;
+    refresh: string;
+    revoke: string;
+    cancel: string;
+    noDelegations: string;
+    delegations: string;
+    expires: string;
+    downloads: string;
+    noJobs: string;
+    url: string;
+    name: string;
+    choose: string;
+    submit: string;
+    destination: string;
+    pending: string;
+    error: string;
+    setupError: string;
+    denied: string;
+    session: string;
+    size: string;
+    queued: string;
+    running: string;
+    succeeded: string;
+    failed: string;
+    canceled: string;
+    interrupted: string;
+    homeScope: string;
+    scopeLabel: string;
+    protectedScope: string;
+    preselection: string;
+    preselectionHelp: string;
+    scopeMismatch: string;
+    scopeChangeHelp: string;
+    confirmScope: string;
+    waiting_executor: string;
+};
+export declare function errorCopy(error: unknown, copy: DelegateCopy): string;

package/dist/src/delegate/executor-setup.d.ts

@@ -0,0 +1,16 @@
+export type CapabilityState = 'unsupported' | 'needs-admin-approval' | 'ready' | 'blocked' | 'incompatible';
+export interface CapabilityStatus {
+    state: CapabilityState;
+    reason?: string;
+    requested?: {
+        scope: string;
+        generation: number;
+    };
+    retry?: boolean;
+}
+export interface ExecutorSetup {
+    status(): Promise<CapabilityStatus>;
+    authorize(password: string, selectedScope?: string): Promise<CapabilityStatus>;
+    control(action: 'start' | 'stop' | 'purge'): Promise<CapabilityStatus>;
+    subscribe?(listener: (status: CapabilityStatus) => void): void;
+}

package/dist/src/delegate/facade.d.ts

@@ -0,0 +1,8 @@
+import type { Context } from '../context';
+import type { BackgroundSaveFacade, OperationRef } from './long-running';
+export interface AppSaveJob extends OperationRef {
+    name: string;
+    refusal?: string;
+}
+/** Bind the UI facade to the App backend's authenticated delegate.* routes (Go package delegate). */
+export declare function createBackgroundSaveFacade(ctx: Pick<Context, 'call'>, jobs?: () => Promise<readonly AppSaveJob[]>): BackgroundSaveFacade;

package/dist/src/delegate/long-running.d.ts

@@ -0,0 +1,74 @@
+export interface SelectDestination {
+    key: string;
+    path: string;
+}
+export interface ScopeSelection {
+    scope: string;
+    root: string;
+    generation: number;
+}
+export interface DestinationState {
+    key: string;
+    selection: ScopeSelection | null;
+    destination: DestinationGrant | null;
+    status: 'active' | 'missing' | 'revoked' | 'reselection-required' | 'needs-scope-confirmation' | 'disabled';
+}
+export interface DestinationGrant {
+    id: string;
+    key: string;
+    path: string;
+    username: string;
+    lifetime: 'until-revoked';
+}
+export type DelegateOperationState = 'queued' | 'copying' | 'committed' | 'canceled' | 'interrupted' | 'uncertain';
+export interface OperationRef {
+    delegation_id: string;
+    job_id: string;
+}
+export interface OperationResult {
+    job_id: string;
+    state: DelegateOperationState;
+    receipt?: {
+        path: string;
+        size: number;
+    };
+    code?: string;
+    reason?: string;
+}
+export interface SaveOperation extends OperationResult, OperationRef {
+    name: string;
+}
+export interface BackgroundSaveStatus {
+    disabled: boolean;
+    selection?: ScopeSelection | null;
+    scopeMode?: string;
+    preselection?: string;
+    mismatch?: boolean;
+}
+export interface DestinationSelection {
+    key: string;
+    selectDestination(input: SelectDestination): Promise<DestinationGrant>;
+}
+export interface BackgroundSaveFacade {
+    destination(key: string): Promise<DestinationState>;
+    exportExample(input: {
+        key: string;
+        job_id: string;
+    }): Promise<OperationRef>;
+    selectDestination(input: SelectDestination): Promise<DestinationGrant>;
+    status(): Promise<BackgroundSaveStatus>;
+    list(): Promise<DestinationGrant[]>;
+    operations(): Promise<SaveOperation[]>;
+    revoke(input: {
+        delegation_id: string;
+    }): Promise<{
+        revoked: true;
+    }>;
+    cancel(input: OperationRef): Promise<OperationResult>;
+    disable(): Promise<{
+        disabled: true;
+    }>;
+    enable(): Promise<{
+        disabled: false;
+    }>;
+}

package/dist/src/delegate/save-copy.d.ts

@@ -0,0 +1,126 @@
+export declare const saveCatalogs: Record<import("..").UiLocale, {
+    title: string;
+    help: string;
+    selection: string;
+    delegations: string;
+    operations: string;
+    empty: string;
+    noOperations: string;
+    revoke: string;
+    choose: string;
+    needs: string;
+    cancel: string;
+    refresh: string;
+    disable: string;
+    enable: string;
+    disableHelp: string;
+    disabled: string;
+    enabled: string;
+    revoked: string;
+    untilRevoked: string;
+    queued: string;
+    copying: string;
+    committed: string;
+    canceled: string;
+    canceling: string;
+    interrupted: string;
+    uncertain: string;
+    uncertainHelp: string;
+    interruptedHelp: string;
+    loading: string;
+    denied: string;
+    session: string;
+    conflict: string;
+    space: string;
+    error: string;
+    scope: string;
+    scopeNeeds: string;
+    scopeMismatch: string;
+    reselect: string;
+    example: string;
+    exampleHelp: string;
+}>;
+export declare function saveCopy(locale?: string): {
+    title: string;
+    help: string;
+    selection: string;
+    delegations: string;
+    operations: string;
+    empty: string;
+    noOperations: string;
+    revoke: string;
+    choose: string;
+    needs: string;
+    cancel: string;
+    refresh: string;
+    disable: string;
+    enable: string;
+    disableHelp: string;
+    disabled: string;
+    enabled: string;
+    revoked: string;
+    untilRevoked: string;
+    queued: string;
+    copying: string;
+    committed: string;
+    canceled: string;
+    canceling: string;
+    interrupted: string;
+    uncertain: string;
+    uncertainHelp: string;
+    interruptedHelp: string;
+    loading: string;
+    denied: string;
+    session: string;
+    conflict: string;
+    space: string;
+    error: string;
+    scope: string;
+    scopeNeeds: string;
+    scopeMismatch: string;
+    reselect: string;
+    example: string;
+    exampleHelp: string;
+};
+export declare function saveError(error: unknown, copy?: {
+    title: string;
+    help: string;
+    selection: string;
+    delegations: string;
+    operations: string;
+    empty: string;
+    noOperations: string;
+    revoke: string;
+    choose: string;
+    needs: string;
+    cancel: string;
+    refresh: string;
+    disable: string;
+    enable: string;
+    disableHelp: string;
+    disabled: string;
+    enabled: string;
+    revoked: string;
+    untilRevoked: string;
+    queued: string;
+    copying: string;
+    committed: string;
+    canceled: string;
+    canceling: string;
+    interrupted: string;
+    uncertain: string;
+    uncertainHelp: string;
+    interruptedHelp: string;
+    loading: string;
+    denied: string;
+    session: string;
+    conflict: string;
+    space: string;
+    error: string;
+    scope: string;
+    scopeNeeds: string;
+    scopeMismatch: string;
+    reselect: string;
+    example: string;
+    exampleHelp: string;
+}): string;

package/dist/src/delegate/scoped-picker.d.ts

@@ -0,0 +1,3 @@
+import type { NasProvider } from '../nas/contract';
+/** A UX bound only; the executor independently enforces its protected scope. */
+export declare function scopedPicker(source: NasProvider, root: string): NasProvider;

package/dist/src/delegate/use-executor-setup.d.ts

@@ -0,0 +1,4 @@
+import { type InjectionKey } from 'vue';
+import type { ExecutorSetup } from './executor-setup';
+export declare const ExecutorSetupKey: InjectionKey<ExecutorSetup>;
+export declare function useExecutorSetup(): ExecutorSetup;

package/dist/src/files/FileBrowser.vue.d.ts

@@ -0,0 +1,17 @@
+import type { NasProvider } from '../nas/contract';
+type __VLS_Props = {
+    provider: NasProvider;
+    locale: string;
+    mode?: 'folder' | 'file';
+    transfers?: boolean;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    selected: (path: string | undefined) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onSelected?: ((path: string | undefined) => any) | undefined;
+}>, {
+    mode: "folder" | "file";
+    transfers: boolean;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/src/files/FilesPage.vue.d.ts

@@ -0,0 +1,7 @@
+import type { Context } from '../context';
+type __VLS_Props = {
+    ctx: Context;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/src/files/transfers.d.ts

@@ -0,0 +1,9 @@
+export interface FileTransport {
+    endpoint: string;
+    token?: () => string | undefined;
+}
+export declare function createFileTransfers(transport: FileTransport): {
+    download(path: string): void;
+    dispose(): void;
+    upload(parent: string, file: File, signal: AbortSignal): Promise<void>;
+};

package/dist/src/i18n.d.ts

@@ -0,0 +1,7 @@
+export type UiLocale = 'en' | 'zh-TW' | 'zh-CN' | 'ja' | 'ko' | 'de' | 'fr' | 'es' | 'it';
+export declare const uiLocales: readonly UiLocale[];
+/** The built-in UI locale (shared by these catalogs and the UI's own text) for a DSM or BCP-47 language tag. */
+export declare function uiLocale(locale: string): UiLocale;
+/** The catalogs of one capability by locale, typed by its en catalog. Each
+ * capability globs its own folder, so a bundle carries only what it imports. */
+export declare function catalogs<T>(files: Record<string, unknown>, _en: T): Record<UiLocale, T>;

package/dist/src/identity/LoginPage.vue.d.ts

@@ -0,0 +1,8 @@
+import type { IdentitySession } from './session';
+type __VLS_Props = {
+    session: IdentitySession;
+    locale: string;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;