@graphite-sports/sdk 0.1.0 → 0.1.1

package/index.d.ts

@@ -11,19 +11,58 @@ import { RefObject } from 'react';
 import { toast } from 'react-hot-toast';
 import type { UnusedSkipTokenOptions } from '@tanstack/react-query';
 
-declare type AnyQuerySchema = QuerySchema<QueryFields>;
+export declare type AnyQuerySchema = QuerySchema<QueryFields>;
 
-export declare function AppButton({ type, onClick, disabled: disabledProp, mutates, children, submit, className, loading, value, ref, href, }: Props): JSX.Element;
+export declare function AppButton({ type, onClick, disabled: disabledProp, mutates, children, submit, className, loading, value, ref, href, }: AppButtonProps): JSX.Element;
 
-declare type AppButtonType = 'primary' | 'secondary' | 'danger';
+export declare type AppButtonProps = {
+    type?: AppButtonType;
+    onClick?: () => void;
+    disabled?: boolean;
+    /** Disabled while read-only (see `useIsReadonly`). */
+    mutates?: boolean;
+    children?: ReactNode;
+    submit?: boolean;
+    className?: string;
+    loading?: boolean;
+    value?: string;
+    ref?: RefObject<HTMLButtonElement | null>;
+    /** Makes the button a link to this route, so it can also be opened in a new tab. `onClick` runs before routing. */
+    href?: string;
+};
+
+export declare type AppButtonType = 'primary' | 'secondary' | 'danger';
 
 export declare const AppInput: {
-    ({ ref, inputRef, ...props }: Props_2 & {
+    ({ ref, inputRef, ...props }: AppInputProps & {
         ref?: React.RefObject<HTMLInputElement | null>;
     }): JSX.Element;
     displayName: string;
 };
 
+export declare type AppInputProps = {
+    label?: string;
+    description?: string;
+    value?: string;
+    onChange?: ChangeEventHandler<HTMLInputElement>;
+    onBlur?: FocusEventHandler<HTMLInputElement>;
+    onFocus?: FocusEventHandler<HTMLInputElement>;
+    onKeyDown?: KeyboardEventHandler<HTMLInputElement>;
+    type?: HTMLInputTypeAttribute;
+    placeholder?: string;
+    required?: boolean;
+    maxLength?: number;
+    pattern?: string;
+    disabled?: boolean;
+    className?: string;
+    tabIndex?: number;
+    readonly?: boolean;
+    layout?: InputLayout;
+    inputRef?: React.RefObject<HTMLInputElement | null>;
+    endAdornment?: ReactNode;
+    autoFocus?: boolean;
+};
+
 declare type ArithmeticOperator = "add" | "subtract";
 
 declare type ArrayValue<T = Primitive> = Value<T>[];
@@ -36,7 +75,7 @@ declare type BIB = Brand<number, 'bib'>;
  * `#/components/schemas/<Name>` entry in the OpenAPI schema - see the `DOMAIN_ID_NAMES` redirect in
  * generate-openapi-types.js, which points the generated schema types at these instead of `number`/`string`.
  */
-declare type Brand<T, B> = T & {
+export declare type Brand<T, B> = T & {
     readonly __brand: B;
 };
 
@@ -142,7 +181,7 @@ export declare type ClassDAO = components['schemas']['ClassDAO'];
 
 export declare type ClassId = Brand<number, 'classId'>;
 
-declare type ClassResponse = components['schemas']['ClassResponse'];
+export declare type ClassResponse = components['schemas']['ClassResponse'];
 
 declare type CommonApiKeyId = Brand<number, 'commonApiKeyId'>;
 
@@ -152,7 +191,7 @@ export declare type CompetitorDAO = components['schemas']['CompetitorDAO'];
 
 export declare type CompetitorId = Brand<number, 'competitorId'>;
 
-declare type CompetitorType = components['schemas']['CompetitorType'];
+export declare type CompetitorType = components['schemas']['CompetitorType'];
 
 declare interface components {
     schemas: {
@@ -1323,7 +1362,9 @@ declare interface components {
             kind: components["schemas"]["ExtensionKind"];
         };
         /** @enum {string} */
-        ExtensionError: "local-extension-not-found" | "failed-to-resolve-extension";
+        ExtensionError: "local-extension-not-found" | "failed-to-resolve-extension" | "failed-to-start" | "invalid-identifier";
+        /** @description A single path segment on every platform without control characters, so it is a safe directory name. */
+        ExtensionIdentifier: string;
         ExtensionKind: {
             /** @constant */
             type: "local";
@@ -1334,9 +1375,19 @@ declare interface components {
         };
         ExtensionPathVariables_for_CommonWorkspaceId: {
             eventId: components["schemas"]["EventId"];
-            extensionIdentifier: string;
+            extensionIdent: components["schemas"]["ExtensionIdentifier"];
             workspaceId: components["schemas"]["CommonWorkspaceId"];
         };
+        ExtensionSecretDTO: {
+            isSet: boolean;
+            /** @description Locale, like `en`, to label */
+            label: {
+                [key: string]: string;
+            };
+            name: components["schemas"]["SecretName"];
+            /** Format: date-time */
+            updatedAt?: string | null;
+        };
         /** @description Allows referencing an external resource for extended documentation. */
         ExternalDocumentation: {
             /**
@@ -2336,7 +2387,7 @@ declare interface components {
         /** Format: uint16 */
         InputIdx: InputIdx;
         InstallExtensionBody: {
-            identifier: string;
+            identifier: components["schemas"]["ExtensionIdentifier"];
             kind: components["schemas"]["ExtensionKind"];
         };
         InstalledExtensionDTO: {
@@ -2441,6 +2492,10 @@ declare interface components {
         } | {
             operationId: string;
         });
+        /** @description Links the entities a template was created from to its archive entries. */
+        LinkToTemplateMutation: {
+            wiring: components["schemas"]["Wiring"];
+        };
         LoadArchiveQuery: {
             /**
              * @description What to do with a root format contained in the archive.
@@ -2448,6 +2503,9 @@ declare interface components {
              */
             rootFormat: components["schemas"]["RootFormatImport"];
         };
+        LocalExtensionPath: {
+            extensionIdent: components["schemas"]["ExtensionIdentifier"];
+        };
         /**
          * Format: uint32
          * @description Identifies a type parameter within a type expression or node signature.
@@ -2640,6 +2698,10 @@ declare interface components {
             /** @constant */
             type: "unlink-from-template";
             data: components["schemas"]["UnlinkFromTemplateMutation"];
+        } | {
+            /** @constant */
+            type: "link-to-template";
+            data: components["schemas"]["LinkToTemplateMutation"];
         };
         LogEntrySmall: {
             description: string;
@@ -4456,6 +4518,17 @@ declare interface components {
             /** @description Additional external documentation for this schema. */
             externalDocs?: components["schemas"]["ExternalDocumentation"] | null;
         };
+        /** @description Only `[a-z0-9-]`, at least one character. */
+        SecretName: string;
+        SecretPath: {
+            extensionIdent: components["schemas"]["ExtensionIdentifier"];
+            name: components["schemas"]["SecretName"];
+        };
+        /** @description At most 16 KiB. Its [Debug] does not show the value. */
+        SecretValue: string;
+        SecretValueBody: {
+            value: components["schemas"]["SecretValue"];
+        };
         /**
          * @description Defines a security scheme that can be used by the operations.
          *      Supported schemes are HTTP authentication, an API key (either as a
@@ -5529,8 +5602,6 @@ export declare interface ExtensionSidebarContribution {
 
 export declare type ExtensionSidebarProps = EventPath;
 
-declare type FieldInput<Field> = Field extends OptionalQueryField<infer Value> ? Value | null : Field extends RepeatedQueryField<infer Value> ? readonly Value[] : never;
-
 declare interface FieldTypeWithDefault {
     fieldType: TypeExpr<Type>;
     /**
@@ -5539,15 +5610,13 @@ declare interface FieldTypeWithDefault {
     default: Value | null;
 }
 
-declare type FieldValue<Field> = Field extends OptionalQueryField<infer Value> ? Value | null : Field extends RepeatedQueryField<infer Value> ? Value[] : never;
-
 declare type FormatGroupId = Brand<number, 'formatGroupId'>;
 
 declare type FormatId = Brand<number, 'formatId'>;
 
-declare type FormatInstanceId = Brand<number, 'formatInstanceId'>;
+export declare type FormatInstanceId = Brand<number, 'formatInstanceId'>;
 
-declare type FormatNodeId = Brand<string, 'formatNodeId'>;
+export declare type FormatNodeId = Brand<string, 'formatNodeId'>;
 
 declare type FormatNodeInstanceId = Brand<number, 'formatNodeInstanceId'>;
 
@@ -5555,12 +5624,14 @@ declare type FormatNodeTestId = Brand<string, 'formatNodeTestId'>;
 
 declare type FormatTestId = Brand<number, 'formatTestId'>;
 
-declare type FormContribution<Props, DTO> = FC<Props & {
+export declare type FormContribution<Props, DTO> = FC<Props & {
     formFieldRegistry: FormFieldRegistry;
     ref: Ref<ContributionHandle<DTO>>;
 }>;
 
-declare interface FormFieldMeta {
+export declare type FormFieldHookId = object;
+
+export declare interface FormFieldMeta {
     /**
      * true if setValue has been called at least once since the last reset
      */
@@ -5586,7 +5657,7 @@ declare interface FormFieldMeta {
     reset: () => void;
 }
 
-declare interface FormFieldProps<I, O = I> {
+export declare interface FormFieldProps<I, O = I> {
     /**
      * Used to check wether or not the mapped persisted value has changed
      * Default: `Object.is`
@@ -5601,9 +5672,9 @@ declare interface FormFieldProps<I, O = I> {
     map?: (value: I) => O;
 }
 
-declare interface FormFieldRegistry {
-    registerFormField: (hookId: HookId, formField: FormFieldMeta) => void;
-    unregisterFormField: (hookId: HookId) => void;
+export declare interface FormFieldRegistry {
+    registerFormField: (hookId: FormFieldHookId, formField: FormFieldMeta) => void;
+    unregisterFormField: (hookId: FormFieldHookId) => void;
     /**
      * `useFormField` bound to this registry. Follows the rules of hooks:
      * only call it at the top level of a component or custom hook.
@@ -5621,15 +5692,15 @@ declare interface FormFieldRegistry {
  * `const [value, setValue, field] = useFormField(...);`
  * `<FormField {...field}>...</FormField>`
  */
-declare type FormFieldState<T> = [value: T, setValue: (value: T | ((oldValue: T) => T)) => void, field: FormFieldMeta];
+export declare type FormFieldState<T> = [value: T, setValue: (value: T | ((oldValue: T) => T)) => void, field: FormFieldMeta];
 
 export declare type GameDAO = components['schemas']['GameDAO'];
 
-declare type GameDTO = components['schemas']['GameDTO'];
+export declare type GameDTO = components['schemas']['GameDTO'];
 
-declare type GameFormatDTO = components['schemas']['GameFormatDTO'];
+export declare type GameFormatDTO = components['schemas']['GameFormatDTO'];
 
-declare type GameFormatId = Brand<number, 'gameFormatId'>;
+export declare type GameFormatId = Brand<number, 'gameFormatId'>;
 
 export declare type GameFormatPageContribution = FormContribution<GameFormatPageProps & {
     gameFormat: GameFormatDTO;
@@ -5651,7 +5722,7 @@ export declare type GamePageProps = EventPath & {
 
 export declare const gamesWithTablesMappedByEventQO: (workspaceId: CommonWorkspaceId, eventId: EventId) => EngineQueryOptions<Map<GameId, GameWithTables>>;
 
-declare type GameWithTables = components['schemas']['GameWithTables'];
+export declare type GameWithTables = components['schemas']['GameWithTables'];
 
 export declare const getClassesByEventQO: (workspaceId: CommonWorkspaceId, eventId: EventId) => EngineQueryOptions<ClassResponse[]>;
 
@@ -5665,11 +5736,9 @@ export declare const getCompetitorsQO: (workspaceId: CommonWorkspaceId, eventId:
  */
 declare type GraphLocation = { type: "Edge"; data: number } | { type: "InputPort"; data: { nodeIdx: number; inputIdx: number } };
 
-declare type HookId = object;
-
 declare type InputIdx = Brand<number, 'inputIdx'>;
 
-declare enum InputLayout {
+export declare enum InputLayout {
     Normal = 0,
     /**
      * Narrow field for tight UI (node ports, toolbars). Overrides the browser's ~20ch input min-width.
@@ -5689,13 +5758,13 @@ declare type LocalParamID = number;
 
 declare type LogId = Brand<number, 'logId'>;
 
-declare type Merge<A, B> = {
+export declare type MergePathParams<A, B> = {
     [K in keyof A | keyof B]: K extends keyof B ? B[K] : K extends keyof A ? A[K] : never;
 };
 
 export declare function Modal({ children, isOpen, onClose, closable, height, width, verticalPosition, horizontalPosition, lightbox, blockBackground, }: ModalProps): null;
 
-declare interface ModalConfig {
+export declare interface ModalConfig {
     id: string;
     content: ReactNode;
     closable?: boolean;
@@ -5708,12 +5777,12 @@ declare interface ModalConfig {
     onClose?: () => void;
 }
 
-declare interface ModalControls {
+export declare interface ModalControls {
     open: (content: ReactNode, options?: Omit<ModalConfig, 'id' | 'content'>) => string;
     close: (id: string) => void;
 }
 
-declare interface ModalProps {
+export declare interface ModalProps {
     children: ReactNode;
     isOpen: boolean;
     onClose: () => void;
@@ -5795,7 +5864,7 @@ declare type NoSupertypeLayerReason = "UnknownTypeParam" | "NodeSignatureInputsV
 
 declare type OperatorOf<T> = Extract<TypeOperators[keyof TypeOperators], [T, unknown]>[1];
 
-declare interface OptionalQueryField<T> {
+export declare interface OptionalQueryField<T> {
     kind: 'optional';
     codec: QueryCodec<T>;
 }
@@ -5814,14 +5883,20 @@ declare interface ParamRef {
     infer: boolean;
 }
 
-declare interface ParsedQuery<Values> {
+export declare interface ParsedQuery<Values> {
     values: Values;
     /** The original search with malformed known values removed and valid values normalized. */
     canonicalSearch: string;
     malformedKeys: string[];
 }
 
-declare type PathParams<Path extends string> = Path extends `${infer Base}/*` ? PathParams<Base> : Path extends `${infer _}/${infer Rest}` ? Merge<SegmentParam<_>, PathParams<Rest>> : SegmentParam<Path>;
+export declare type PathParams<Path extends string> = Path extends `${infer Base}/*` ? PathParams<Base> : Path extends `${infer _}/${infer Rest}` ? MergePathParams<PathSegmentParam<_>, PathParams<Rest>> : PathSegmentParam<Path>;
+
+export declare type PathSegmentParam<S extends string> = S extends `:${infer P}` ? {
+    [K in P]: number;
+} : S extends `$${infer P}` ? {
+    [K in P]: string;
+} : Record<never, never>;
 
 /**
  * A list of port types, optionally with a variadic type (`...T`).
@@ -5836,66 +5911,32 @@ declare interface PortTypes<T, R = ParamRef> {
  */
 declare type Primitive = never;
 
-declare type Props = {
-    type?: AppButtonType;
-    onClick?: () => void;
-    disabled?: boolean;
-    /** Disabled while read-only (see `useIsReadonly`). */
-    mutates?: boolean;
-    children?: ReactNode;
-    submit?: boolean;
-    className?: string;
-    loading?: boolean;
-    value?: string;
-    ref?: RefObject<HTMLButtonElement | null>;
-    /** Makes the button a link to this route, so it can also be opened in a new tab. `onClick` runs before routing. */
-    href?: string;
-};
-
-declare type Props_2 = {
-    label?: string;
-    description?: string;
-    value?: string;
-    onChange?: ChangeEventHandler<HTMLInputElement>;
-    onBlur?: FocusEventHandler<HTMLInputElement>;
-    onFocus?: FocusEventHandler<HTMLInputElement>;
-    onKeyDown?: KeyboardEventHandler<HTMLInputElement>;
-    type?: HTMLInputTypeAttribute;
-    placeholder?: string;
-    required?: boolean;
-    maxLength?: number;
-    disabled?: boolean;
-    className?: string;
-    tabIndex?: number;
-    readonly?: boolean;
-    layout?: InputLayout;
-    inputRef?: React.RefObject<HTMLInputElement | null>;
-    endAdornment?: ReactNode;
-    autoFocus?: boolean;
-};
-
-declare interface QueryCodec<T> {
+export declare interface QueryCodec<T> {
     parse(value: string): T | null;
     serialize(value: T): string;
 }
 
-declare type QueryField = OptionalQueryField<unknown> | RepeatedQueryField<unknown>;
+export declare type QueryField = OptionalQueryField<unknown> | RepeatedQueryField<unknown>;
+
+export declare type QueryFieldInput<Field> = Field extends OptionalQueryField<infer Value> ? Value | null : Field extends RepeatedQueryField<infer Value> ? readonly Value[] : never;
 
-declare type QueryFields = Record<string, QueryField>;
+export declare type QueryFields = Record<string, QueryField>;
 
-declare type QueryInput<Schema extends AnyQuerySchema> = Schema extends QuerySchema<infer Fields> ? {
-    [Key in keyof Fields]?: FieldInput<Fields[Key]>;
+export declare type QueryFieldValue<Field> = Field extends OptionalQueryField<infer Value> ? Value | null : Field extends RepeatedQueryField<infer Value> ? Value[] : never;
+
+export declare type QueryInput<Schema extends AnyQuerySchema> = Schema extends QuerySchema<infer Fields> ? {
+    [Key in keyof Fields]?: QueryFieldInput<Fields[Key]>;
 } : never;
 
-declare interface QuerySchema<Fields extends QueryFields> {
+export declare interface QuerySchema<Fields extends QueryFields> {
     readonly fields: Fields;
     parse(search: string): ParsedQuery<{
-        [Key in keyof Fields]: FieldValue<Fields[Key]>;
+        [Key in keyof Fields]: QueryFieldValue<Fields[Key]>;
     }>;
     serialize(input?: {
-        [Key in keyof Fields]?: FieldInput<Fields[Key]>;
+        [Key in keyof Fields]?: QueryFieldInput<Fields[Key]>;
     }): string;
-    set<Key extends keyof Fields>(search: string, key: Key, value: FieldValue<Fields[Key]>): string;
+    set<Key extends keyof Fields>(search: string, key: Key, value: QueryFieldValue<Fields[Key]>): string;
 }
 
 /**
@@ -5911,12 +5952,12 @@ declare interface RecordTypeWithDefaults {
 
 declare type RecordValue<T = Primitive> = Record<string, Value<T>>;
 
-declare interface RepeatedQueryField<T> {
+export declare interface RepeatedQueryField<T> {
     kind: 'repeated';
     codec: QueryCodec<T>;
 }
 
-declare interface RouterContextType {
+export declare interface RouterContextType {
     /** The pathname used for route matching and persistence keys. */
     path: string;
     /** The complete reactive browser location. */
@@ -5934,7 +5975,7 @@ declare interface RouterContextType {
     unregister: (route: string) => void;
 }
 
-declare interface RouterLocation {
+export declare interface RouterLocation {
     pathname: string;
     search: string;
     hash: string;
@@ -5962,12 +6003,6 @@ declare interface Rows<SortingState> {
     rows: Row[];
 }
 
-declare type SegmentParam<S extends string> = S extends `:${infer P}` ? {
-    [K in P]: number;
-} : S extends `$${infer P}` ? {
-    [K in P]: string;
-} : Record<never, never>;
-
 declare type SerializableNonPrimitiveValue = { type: "game-table"; data: Table<Unsorted_2, StateMetadata> } | { type: "game-table-sorted"; data: Table<Sorted_2, StateMetadata> } | { type: "row"; data: Row } | { type: "class"; data: number } | { type: "closure" };
 
 declare type Sorted = Brand<'sorted', 'sorted'>;
@@ -5993,7 +6028,7 @@ declare interface StateMetadata {
  */
 declare type Table<SortingState, M = NoMetadata> = { rows: Rows<SortingState> } & M;
 
-declare type TableId = Brand<number, 'tableId'>;
+export declare type TableId = Brand<number, 'tableId'>;
 
 declare type TableLineageId = Brand<number, 'tableLineageId'>;
 
@@ -6078,8 +6113,8 @@ export declare type WorkingGameDTO = Omit<GameDTO, 'gameFormatId'> & {
     gameFormatId: GameFormatId | null;
 };
 
-declare type WorkspaceRootId = Brand<number, 'workspaceRootId'>;
+export declare type WorkspaceRootId = Brand<number, 'workspaceRootId'>;
 
-declare type WorkspaceSelfHostedId = Brand<number, 'workspaceSelfHostedId'>;
+export declare type WorkspaceSelfHostedId = Brand<number, 'workspaceSelfHostedId'>;
 
 export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphite-sports/sdk",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "license": "MIT",
   "repository": "github:Graphite-sports/starter-extension",
   "homepage": "https://github.com/Graphite-sports/starter-extension",