@nxtedition/types 23.0.53 → 23.0.55

package/dist/common/settings.d.ts

@@ -2,6 +2,7 @@ import type { Paths } from 'type-fest';
 import type { PipelineSortMode } from './pipeline.ts';
 import type { PromotedTag } from './promoted-tag.ts';
 import type { NotificationReason } from './user-notification.ts';
+import type { SubtitleStyle } from './subtitle-style.ts';
 export interface Settings {
     autoLogoutTime?: number;
     permission?: {
@@ -175,6 +176,7 @@ export interface Settings {
                 label?: string | null;
                 color?: string | null;
             }>;
+            overridableProperties?: Array<keyof SubtitleStyle | null>;
         };
         subtitleTemplateId?: string;
         initialVolume?: string;

package/dist/nxtpression.d.ts

@@ -361,13 +361,13 @@ declare interface CommentReadMarkDomainRecords {
 }
 
 declare interface ConnectionBase {
-    type: string | null;
+    type?: string | null;
     userNotificationsEnabled?: boolean;
 }
 
 declare interface ConnectionDef<Type extends string | null> {
     connection: ConnectionBase & {
-        type: Type;
+        type?: Type;
     };
     methods: ConnectionMethodsBase;
     stats: ConnectionStatsBase;
@@ -492,7 +492,7 @@ declare interface EmptyConnectionDef extends ConnectionDef<null> {
 }
 
 declare interface EmptyConnectionRecord extends ConnectionBase {
-    type: null;
+    type?: null;
 }
 
 /**
@@ -611,7 +611,7 @@ declare interface FacebookConnectionDef extends ConnectionDef<"facebook"> {
 }
 
 declare interface FacebookConnectionRecord extends ConnectionBase {
-    type: "facebook";
+    type?: "facebook";
     grantedScopes?: string[];
 }
 
@@ -645,8 +645,8 @@ declare interface File_2 {
 }
 
 declare interface FileConnectionBase extends ConnectionBase {
-    type: "file";
-    protocol: string;
+    type?: "file";
+    protocol?: string;
     host?: string;
     port?: number | string;
     ignoreMissing?: boolean;
@@ -655,7 +655,7 @@ declare interface FileConnectionBase extends ConnectionBase {
     pollInterval?: number;
     listConcurrency?: number;
     metafile?: {
-        content: string;
+        content?: string;
     };
 }
 
@@ -666,25 +666,84 @@ declare interface FileConnectionDef extends ConnectionDef<"file"> {
 }
 
 declare interface FileConnectionFtpRecord extends FileConnectionBase {
-    protocol: "ftp";
-    host: string;
+    protocol?: "ftp";
+    host?: string;
     username?: string;
     password?: string;
     utf8?: boolean;
     timezone?: string;
 }
 
-declare type FileConnectionRecord = FileConnectionS3Record | FileConnectionFtpRecord | FileConnectionSmbRecord | FileConnectionSftpRecord;
+declare interface FileConnectionHeadResponse {
+    size?: number;
+    hash?: string;
+}
+
+declare interface FileConnectionHttpAction<RequestTemplateContext extends Record<string, unknown> = Record<string, unknown>, ResponseHandlerResult = undefined> {
+    request?: {
+        [Key in keyof HttpConnectionRequest]: Nxtpression<HttpConnectionRequest[Key], RequestTemplateContext & {
+            connection: FileConnectionHttpRecord;
+        }>;
+    };
+    response?: HttpConnectionResponseHandler<ResponseHandlerResult>;
+}
+
+declare interface FileConnectionHttpRecord extends FileConnectionBase {
+    protocol?: "http";
+    secure?: boolean;
+    authType?: "oauth2" | "none";
+    oauth2?: {
+        client?: {
+            id?: string;
+            secret?: string;
+            secretParamName?: string;
+            idParamName?: string;
+        };
+        auth?: {
+            tokenHost?: string;
+            tokenPath?: string;
+            refreshPath?: string;
+            revokePath?: string;
+        };
+        /**
+         * Default (static) parameters to be sent with the token request.
+         * Username and password should not be stored here, but rather provided
+         * by the hub through the `connect` rpc method.
+         */
+        tokenParams?: {
+            [key: string]: string;
+        };
+        grantType?: "password";
+        token?: {
+            accessToken: string;
+            refreshToken: string | null;
+            expiresAt: number | null;
+            idToken?: string;
+        };
+        error?: string;
+    };
+    actions?: HttpConnectionActions;
+}
+
+declare interface FileConnectionListResponseItem {
+    name: string;
+    isDir: boolean;
+    size: number;
+    date?: string;
+    path: string;
+}
+
+declare type FileConnectionRecord = FileConnectionFtpRecord | FileConnectionHttpRecord | FileConnectionS3Record | FileConnectionSmbRecord | FileConnectionSftpRecord;
 
 declare interface FileConnectionS3Record extends FileConnectionBase {
-    protocol: "s3";
+    protocol?: "s3";
     client?: unknown;
     bucket?: string;
 }
 
 declare interface FileConnectionSftpRecord extends FileConnectionBase {
-    protocol: "sftp";
-    host: string;
+    protocol?: "sftp";
+    host?: string;
     username?: string;
     password?: string;
     privateKey?: string;
@@ -695,9 +754,9 @@ declare interface FileConnectionSftpRecord extends FileConnectionBase {
 }
 
 declare interface FileConnectionSmbRecord extends FileConnectionBase {
-    protocol: "smb";
-    host: string;
-    share: string;
+    protocol?: "smb";
+    host?: string;
+    share?: string;
     workgroup?: string;
     username?: string;
     password?: string;
@@ -939,6 +998,71 @@ declare interface HorizontalRuleContent {
     type: "horizontalrule";
 }
 
+declare interface HttpConnectionActions {
+    ping?: FileConnectionHttpAction;
+    head?: FileConnectionHttpAction<{
+        filepath: string;
+    }, FileConnectionHeadResponse | undefined>;
+    list?: FileConnectionHttpAction<{
+        dirpath?: string;
+    }, FileConnectionListResponseItem[]>;
+    get?: FileConnectionHttpAction<{
+        id: string;
+        offset?: number;
+    }>;
+    put?: FileConnectionHttpAction<{
+        filepath: string;
+        stream: unknown;
+    }>;
+    del?: FileConnectionHttpAction<{
+        id: string;
+    }>;
+}
+
+declare interface HttpConnectionRequest {
+    origin?: string;
+    path?: string;
+    method?: string;
+    params?: {
+        [key: string]: string | undefined;
+    };
+    form?: {
+        [name: string]: {
+            value: unknown;
+            filename: string | undefined;
+        };
+    };
+    headers?: {
+        [key: string]: string | undefined;
+    };
+    throwOnError?: boolean;
+}
+
+/**
+ * Describes how to handle the response from an HTTP action
+ */
+declare interface HttpConnectionResponseHandler<ResOutput = undefined> {
+    responseFormat?: "text" | "json" | "stream";
+    /** Resolve to an error message to indicate failure */
+    error?: Nxtpression<string | null | undefined, {
+        connection: FileConnectionHttpRecord;
+        headers: Record<string, string | string[] | undefined>;
+        statusCode: number;
+    }>;
+    /** Resolve to the desired output. Input will be parsed according to responseFormat. */
+    transform?: Nxtpression<ResOutput, {
+        connection: FileConnectionHttpRecord;
+        /** Body parsed as JSON if responseFormat is 'json' */
+        json?: unknown;
+        /** Body as text if responseFormat is 'text' */
+        text?: string;
+        /** Response headers */
+        headers: Record<string, string | string[] | undefined>;
+        /** Response status code */
+        statusCode: number;
+    }>;
+}
+
 /**
  An if-else-like type that resolves depending on whether the given `boolean` type is `true` or `false`.
 
@@ -2270,7 +2394,7 @@ declare interface ReutersConnectionDef extends ConnectionDef<"reuters"> {
 }
 
 declare interface ReutersConnectionRecord extends ConnectionBase {
-    type: "reuters";
+    type?: "reuters";
     clientId?: string;
     clientSecret?: string;
     audience?: string;
@@ -2643,6 +2767,7 @@ declare interface Settings {
                 label?: string | null;
                 color?: string | null;
             }>;
+            overridableProperties?: Array<keyof SubtitleStyle | null>;
         };
         subtitleTemplateId?: string;
         initialVolume?: string;
@@ -3369,7 +3494,7 @@ declare interface UserDomainReceivedNotificationsProvidedRecord {
 }
 
 declare interface UserDomainRecord {
-    username?: string;
+    username?: string | null;
     roles?: string[];
 }
 

package/dist/records/domains/connection/empty.d.ts

@@ -3,5 +3,5 @@ export interface EmptyConnectionDef extends ConnectionDef<null> {
     connection: EmptyConnectionRecord;
 }
 export interface EmptyConnectionRecord extends ConnectionBase {
-    type: null;
+    type?: null;
 }

package/dist/records/domains/connection/facebook.d.ts

@@ -3,6 +3,6 @@ export interface FacebookConnectionDef extends ConnectionDef<"facebook"> {
     connection: FacebookConnectionRecord;
 }
 export interface FacebookConnectionRecord extends ConnectionBase {
-    type: "facebook";
+    type?: "facebook";
     grantedScopes?: string[];
 }

package/dist/records/domains/connection/file/ftp.d.ts

@@ -1,7 +1,7 @@
 import type { FileConnectionBase } from './index.ts';
 export interface FileConnectionFtpRecord extends FileConnectionBase {
-    protocol: "ftp";
-    host: string;
+    protocol?: "ftp";
+    host?: string;
     username?: string;
     password?: string;
     utf8?: boolean;

package/dist/records/domains/connection/file/http.d.ts

@@ -0,0 +1,130 @@
+import type { FileConnectionBase } from './index.ts';
+import type { Nxtpression } from '../../../../common/nxtpression.ts';
+export interface FileConnectionHttpRecord extends FileConnectionBase {
+    protocol?: "http";
+    secure?: boolean;
+    authType?: "oauth2" | "none";
+    oauth2?: {
+        client?: {
+            id?: string;
+            secret?: string;
+            secretParamName?: string;
+            idParamName?: string;
+        };
+        auth?: {
+            tokenHost?: string;
+            tokenPath?: string;
+            refreshPath?: string;
+            revokePath?: string;
+        };
+        /**
+         * Default (static) parameters to be sent with the token request.
+         * Username and password should not be stored here, but rather provided
+         * by the hub through the `connect` rpc method.
+         */
+        tokenParams?: {
+            [key: string]: string;
+        };
+        grantType?: "password";
+        token?: {
+            accessToken: string;
+            refreshToken: string | null;
+            expiresAt: number | null;
+            idToken?: string;
+        };
+        error?: string;
+    };
+    actions?: HttpConnectionActions;
+}
+export interface HttpConnectionActions {
+    ping?: FileConnectionHttpAction;
+    head?: FileConnectionHttpAction<{
+        filepath: string;
+    }, FileConnectionHeadResponse | undefined>;
+    list?: FileConnectionHttpAction<{
+        dirpath?: string;
+    }, FileConnectionListResponseItem[]>;
+    get?: FileConnectionHttpAction<{
+        id: string;
+        offset?: number;
+    }>;
+    put?: FileConnectionHttpAction<{
+        filepath: string;
+        stream: unknown;
+    }>;
+    del?: FileConnectionHttpAction<{
+        id: string;
+    }>;
+}
+export interface FileConnectionHttpAction<RequestTemplateContext extends Record<string, unknown> = Record<string, unknown>, ResponseHandlerResult = undefined> {
+    request?: {
+        [Key in keyof HttpConnectionRequest]: Nxtpression<HttpConnectionRequest[Key], RequestTemplateContext & {
+            connection: FileConnectionHttpRecord;
+        }>;
+    };
+    response?: HttpConnectionResponseHandler<ResponseHandlerResult>;
+}
+export interface HttpConnectionRequest {
+    origin?: string;
+    path?: string;
+    method?: string;
+    params?: {
+        [key: string]: string | undefined;
+    };
+    form?: {
+        [name: string]: {
+            value: unknown;
+            filename: string | undefined;
+        };
+    };
+    headers?: {
+        [key: string]: string | undefined;
+    };
+    throwOnError?: boolean;
+}
+export declare const isHttpConnectionRequest: (input: unknown) => input is HttpConnectionRequest;
+/**
+ * Describes how to handle the response from an HTTP action
+ */
+export interface HttpConnectionResponseHandler<ResOutput = undefined> {
+    responseFormat?: "text" | "json" | "stream";
+    /** Resolve to an error message to indicate failure */
+    error?: Nxtpression<string | null | undefined, {
+        connection: FileConnectionHttpRecord;
+        headers: Record<string, string | string[] | undefined>;
+        statusCode: number;
+    }>;
+    /** Resolve to the desired output. Input will be parsed according to responseFormat. */
+    transform?: Nxtpression<ResOutput, {
+        connection: FileConnectionHttpRecord;
+        /** Body parsed as JSON if responseFormat is 'json' */
+        json?: unknown;
+        /** Body as text if responseFormat is 'text' */
+        text?: string;
+        /** Response headers */
+        headers: Record<string, string | string[] | undefined>;
+        /** Response status code */
+        statusCode: number;
+    }>;
+}
+export interface FileConnectionHttpPasswordAuth {
+    username: string;
+    password: string;
+    scope?: string[];
+    resource?: string | string[];
+}
+export declare const isFileConnectionHttpPasswordAuth: (input: unknown) => input is FileConnectionHttpPasswordAuth;
+interface FileConnectionHeadResponse {
+    size?: number;
+    hash?: string;
+}
+export declare const isFileConnectionHeadResponse: (input: unknown) => input is FileConnectionHeadResponse;
+export interface FileConnectionListResponseItem {
+    name: string;
+    isDir: boolean;
+    size: number;
+    date?: string;
+    path: string;
+}
+export declare const isFileConnectionListResponseItem: (input: unknown) => input is FileConnectionListResponseItem;
+export {};

package/dist/records/domains/connection/file/http.js

@@ -0,0 +1,20 @@
+import typia from 'typia';
+export const isHttpConnectionRequest = (() => { const _io0 = input => (undefined === input.origin || "string" === typeof input.origin) && (undefined === input.path || "string" === typeof input.path) && (undefined === input.method || "string" === typeof input.method) && (undefined === input.params || "object" === typeof input.params && null !== input.params && false === Array.isArray(input.params) && _io1(input.params)) && (undefined === input.form || "object" === typeof input.form && null !== input.form && false === Array.isArray(input.form) && _io2(input.form)) && (undefined === input.headers || "object" === typeof input.headers && null !== input.headers && false === Array.isArray(input.headers) && _io4(input.headers)) && (undefined === input.throwOnError || "boolean" === typeof input.throwOnError); const _io1 = input => Object.keys(input).every(key => {
+    const value = input[key];
+    if (undefined === value)
+        return true;
+    return undefined === value || "string" === typeof value;
+}); const _io2 = input => Object.keys(input).every(key => {
+    const value = input[key];
+    if (undefined === value)
+        return true;
+    return "object" === typeof value && null !== value && _io3(value);
+}); const _io3 = input => true && (undefined === input.filename || "string" === typeof input.filename); const _io4 = input => Object.keys(input).every(key => {
+    const value = input[key];
+    if (undefined === value)
+        return true;
+    return undefined === value || "string" === typeof value;
+}); return input => "object" === typeof input && null !== input && false === Array.isArray(input) && _io0(input); })();
+export const isFileConnectionHttpPasswordAuth = (() => { const _io0 = input => "string" === typeof input.username && "string" === typeof input.password && (undefined === input.scope || Array.isArray(input.scope) && input.scope.every(elem => "string" === typeof elem)) && (null !== input.resource && (undefined === input.resource || "string" === typeof input.resource || Array.isArray(input.resource) && input.resource.every(elem => "string" === typeof elem))); return input => "object" === typeof input && null !== input && _io0(input); })();
+export const isFileConnectionHeadResponse = (() => { const _io0 = input => (undefined === input.size || "number" === typeof input.size) && (undefined === input.hash || "string" === typeof input.hash); return input => "object" === typeof input && null !== input && false === Array.isArray(input) && _io0(input); })();
+export const isFileConnectionListResponseItem = (() => { const _io0 = input => "string" === typeof input.name && "boolean" === typeof input.isDir && "number" === typeof input.size && (undefined === input.date || "string" === typeof input.date) && "string" === typeof input.path; return input => "object" === typeof input && null !== input && _io0(input); })();

package/dist/records/domains/connection/file/index.d.ts

@@ -1,6 +1,8 @@
 import type { ConnectionDef, ConnectionMethodsBase, ConnectionBase, ConnectionStatsBase } from '../index.ts';
 import type { FileConnectionFtpRecord } from './ftp.ts';
 export * from './ftp.ts';
+import type { FileConnectionHttpRecord } from './http.ts';
+export * from './http.ts';
 import type { FileConnectionS3Record } from './s3.ts';
 export * from './s3.ts';
 import type { FileConnectionSmbRecord } from './smb.ts';
@@ -12,10 +14,10 @@ export interface FileConnectionDef extends ConnectionDef<"file"> {
     methods: ConnectionMethodsBase;
     stats: ConnectionStatsBase;
 }
-export type FileConnectionRecord = FileConnectionS3Record | FileConnectionFtpRecord | FileConnectionSmbRecord | FileConnectionSftpRecord;
+export type FileConnectionRecord = FileConnectionFtpRecord | FileConnectionHttpRecord | FileConnectionS3Record | FileConnectionSmbRecord | FileConnectionSftpRecord;
 export interface FileConnectionBase extends ConnectionBase {
-    type: "file";
-    protocol: string;
+    type?: "file";
+    protocol?: string;
     host?: string;
     port?: number | string;
     ignoreMissing?: boolean;
@@ -24,6 +26,6 @@ export interface FileConnectionBase extends ConnectionBase {
     pollInterval?: number;
     listConcurrency?: number;
     metafile?: {
-        content: string;
+        content?: string;
     };
 }

package/dist/records/domains/connection/file/index.js

@@ -1,4 +1,5 @@
 export * from "./ftp.js";
+export * from "./http.js";
 export * from "./s3.js";
 export * from "./smb.js";
 export * from "./sftp.js";

package/dist/records/domains/connection/file/s3.d.ts

@@ -1,6 +1,6 @@
 import type { FileConnectionBase } from './index.ts';
 export interface FileConnectionS3Record extends FileConnectionBase {
-    protocol: "s3";
+    protocol?: "s3";
     client?: unknown;
     bucket?: string;
 }

package/dist/records/domains/connection/file/sftp.d.ts

@@ -1,7 +1,7 @@
 import type { FileConnectionBase } from './index.ts';
 export interface FileConnectionSftpRecord extends FileConnectionBase {
-    protocol: "sftp";
-    host: string;
+    protocol?: "sftp";
+    host?: string;
     username?: string;
     password?: string;
     privateKey?: string;

package/dist/records/domains/connection/file/smb.d.ts

@@ -1,8 +1,8 @@
 import type { FileConnectionBase } from './index.ts';
 export interface FileConnectionSmbRecord extends FileConnectionBase {
-    protocol: "smb";
-    host: string;
-    share: string;
+    protocol?: "smb";
+    host?: string;
+    share?: string;
     workgroup?: string;
     username?: string;
     password?: string;

package/dist/records/domains/connection/index.d.ts

@@ -17,13 +17,13 @@ export interface ConnectionDomainRecords {
 }
 export interface ConnectionDef<Type extends string | null> {
     connection: ConnectionBase & {
-        type: Type;
+        type?: Type;
     };
     methods: ConnectionMethodsBase;
     stats: ConnectionStatsBase;
 }
 export interface ConnectionBase {
-    type: string | null;
+    type?: string | null;
     userNotificationsEnabled?: boolean;
 }
 export interface ConnectionMethodsBase {

package/dist/records/domains/connection/reuters.d.ts

@@ -3,7 +3,7 @@ export interface ReutersConnectionDef extends ConnectionDef<"reuters"> {
     connection: ReutersConnectionRecord;
 }
 export interface ReutersConnectionRecord extends ConnectionBase {
-    type: "reuters";
+    type?: "reuters";
     clientId?: string;
     clientSecret?: string;
     audience?: string;

package/dist/records/domains/user.d.ts

@@ -5,7 +5,7 @@ export interface UserDomainRecords {
     ":user.unseenNotifications?": UserDomainUnseenNotificationsRecord;
 }
 export interface UserDomainRecord {
-    username?: string;
+    username?: string | null;
     roles?: string[];
 }
 export interface UserDomainLatestSeenNotificationRecord {