Skip to content

chore: update contracts for studio dashboard remake #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
artiphishle merged 2 commits into from
Jul 21, 2026
Merged

chore: update contracts for studio dashboard remake #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7100bdc
chore: update contracts for studio dashboard remake
artiphishle Jul 21, 2026
d901e56
chore: CR to change 'patch' to 'major'
artiphishle Jul 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/canonical-manifest-category.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@ankhorage/contracts': major
---

Add canonical AppManifest metadata category ownership using the shared AppCategory contract.
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@

# CONTRACTS

![license: MIT](././paradox/badges/license.svg) ![npm: v1.19.4](././paradox/badges/npm.svg) ![runtime: bun](././paradox/badges/runtime.svg) ![typescript: strict](././paradox/badges/typescript.svg) ![eslint: checked](././paradox/badges/eslint.svg) ![prettier: checked](././paradox/badges/prettier.svg) ![build: checked](././paradox/badges/build.svg) ![tests: checked](././paradox/badges/tests.svg) ![docs: paradox](././paradox/badges/docs.svg)
![license: MIT](././paradox/badges/license.svg) ![npm: v3.0.0](././paradox/badges/npm.svg) ![runtime: bun](././paradox/badges/runtime.svg) ![typescript: strict](././paradox/badges/typescript.svg) ![eslint: checked](././paradox/badges/eslint.svg) ![prettier: checked](././paradox/badges/prettier.svg) ![build: checked](././paradox/badges/build.svg) ![tests: checked](././paradox/badges/tests.svg) ![docs: paradox](././paradox/badges/docs.svg)

Serializable app, action, and theme config contracts for Ankhorage.
Serializable app, action, theme, auth, and secret-store contracts for Ankhorage.

## Generated documentation

Expand Down
8 changes: 4 additions & 4 deletions paradox/badges/npm.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions paradox/diagrams/architecture-overview.mmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ graph TD
package__ankhorage_contracts --> entrypoint_src_index_ts
module_src_auth_ts["src/auth.ts"]
package__ankhorage_contracts -.-> module_src_auth_ts
module_src_auth_ts --> module_src_secrets_ts
module_src_auth_ts --> module_src_types_ts
module_src_bindings_ts["src/bindings.ts"]
package__ankhorage_contracts -.-> module_src_bindings_ts
Expand Down Expand Up @@ -76,6 +77,11 @@ graph TD
module_src_runtimeCallbacks_ts["src/runtimeCallbacks.ts"]
package__ankhorage_contracts -.-> module_src_runtimeCallbacks_ts
module_src_runtimeCallbacks_ts --> module_src_types_ts
module_src_secretManifest_ts["src/secretManifest.ts"]
package__ankhorage_contracts -.-> module_src_secretManifest_ts
module_src_secretManifest_ts --> module_src_secrets_ts
module_src_secrets_ts["src/secrets.ts"]
package__ankhorage_contracts -.-> module_src_secrets_ts
module_src_state_ts["src/state.ts"]
package__ankhorage_contracts -.-> module_src_state_ts
module_src_storage_ts["src/storage.ts"]
Expand Down
138 changes: 126 additions & 12 deletions paradox/diagrams/export-graph.mmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ graph LR
module_src_nutrition_review_ts["src/nutrition/review.ts"]
module_src_requirements_ts["src/requirements.ts"]
module_src_runtimeCallbacks_ts["src/runtimeCallbacks.ts"]
module_src_secretManifest_ts["src/secretManifest.ts"]
module_src_secrets_ts["src/secrets.ts"]
module_src_state_ts["src/state.ts"]
module_src_storage_ts["src/storage.ts"]
module_src_types_ts["src/types.ts"]
Expand Down Expand Up @@ -125,6 +127,7 @@ graph LR
export_AppGeneratedApiDefinition -.-> export_DataContractValue
export_AppManifest["AppManifest"]
module_src_types_ts --> export_AppManifest
export_AppManifest -.-> export_AppCategory
export_AppManifest -.-> export_AppDataManifest
export_AppManifest -.-> export_AppSettings
export_AppManifest -.-> export_ComponentDataBinding
Expand All @@ -138,8 +141,18 @@ graph LR
module_src_types_ts --> export_AppSettings
export_AUTH_IDENTIFIER_KINDS["AUTH_IDENTIFIER_KINDS"]
module_src_auth_ts --> export_AUTH_IDENTIFIER_KINDS
export_AUTH_OAUTH_CANCELLATION_REASONS["AUTH_OAUTH_CANCELLATION_REASONS"]
module_src_auth_ts --> export_AUTH_OAUTH_CANCELLATION_REASONS
export_AUTH_OAUTH_ERROR_CODES["AUTH_OAUTH_ERROR_CODES"]
module_src_auth_ts --> export_AUTH_OAUTH_ERROR_CODES
export_AUTH_OAUTH_ERROR_STAGES["AUTH_OAUTH_ERROR_STAGES"]
module_src_auth_ts --> export_AUTH_OAUTH_ERROR_STAGES
export_AUTH_OAUTH_PROVIDER_IDS["AUTH_OAUTH_PROVIDER_IDS"]
module_src_auth_ts --> export_AUTH_OAUTH_PROVIDER_IDS
export_AUTH_OAUTH_TRANSPORT_CANCELLATION_REASONS["AUTH_OAUTH_TRANSPORT_CANCELLATION_REASONS"]
module_src_auth_ts --> export_AUTH_OAUTH_TRANSPORT_CANCELLATION_REASONS
export_AUTH_OAUTH_TRANSPORT_ERROR_CODES["AUTH_OAUTH_TRANSPORT_ERROR_CODES"]
module_src_auth_ts --> export_AUTH_OAUTH_TRANSPORT_ERROR_CODES
export_AUTH_PROFILE_CREATE_STRATEGIES["AUTH_PROFILE_CREATE_STRATEGIES"]
module_src_types_ts --> export_AUTH_PROFILE_CREATE_STRATEGIES
export_AUTH_PROFILE_FIELDS["AUTH_PROFILE_FIELDS"]
Expand All @@ -161,20 +174,17 @@ graph LR
export_AuthAdapter["AuthAdapter"]
module_src_auth_ts --> export_AuthAdapter
export_AuthAdapter -.-> export_AuthAdapterCapabilities
export_AuthAdapter -.-> export_AuthOAuthRedirect
export_AuthAdapter -.-> export_AuthOAuthAdapter
export_AuthAdapter -.-> export_AuthResult
export_AuthAdapter -.-> export_AuthSession
export_AuthAdapter -.-> export_AuthUser
export_AuthAdapter -.-> export_CompleteOAuthSignInInput
export_AuthAdapter -.-> export_PasswordResetInput
export_AuthAdapter -.-> export_SignInInput
export_AuthAdapter -.-> export_SignInWithOAuthInput
export_AuthAdapter -.-> export_SignOutInput
export_AuthAdapter -.-> export_SignUpInput
export_AuthAdapter -.-> export_VerifyOtpInput
export_AuthAdapterCapabilities["AuthAdapterCapabilities"]
module_src_auth_ts --> export_AuthAdapterCapabilities
export_AuthAdapterCapabilities -.-> export_AuthOAuthProviderId
export_AuthAdapterError["AuthAdapterError"]
module_src_auth_ts --> export_AuthAdapterError
export_AuthFlowConfig["AuthFlowConfig"]
Expand All @@ -183,18 +193,49 @@ graph LR
module_src_auth_ts --> export_AuthIdentifier
export_AuthIdentifierKind["AuthIdentifierKind"]
module_src_auth_ts --> export_AuthIdentifierKind
export_AuthOAuthAdapter["AuthOAuthAdapter"]
module_src_auth_ts --> export_AuthOAuthAdapter
export_AuthOAuthAdapter -.-> export_AuthOAuthCapabilities
export_AuthOAuthAdapter -.-> export_AuthOAuthCompletionResult
export_AuthOAuthAdapter -.-> export_AuthOAuthStartResult
export_AuthOAuthAdapter -.-> export_CompleteOAuthAuthorizationInput
export_AuthOAuthAdapter -.-> export_StartOAuthAuthorizationInput
export_AuthOAuthAuthorizationRequest["AuthOAuthAuthorizationRequest"]
module_src_auth_ts --> export_AuthOAuthAuthorizationRequest
export_AuthOAuthAuthorizationRequest -.-> export_AuthOAuthProviderId
export_AuthOAuthAuthorizationResponse["AuthOAuthAuthorizationResponse"]
module_src_auth_ts --> export_AuthOAuthAuthorizationResponse
export_AuthOAuthCancellationReason["AuthOAuthCancellationReason"]
module_src_auth_ts --> export_AuthOAuthCancellationReason
export_AuthOAuthCapabilities["AuthOAuthCapabilities"]
module_src_auth_ts --> export_AuthOAuthCapabilities
export_AuthOAuthCapabilities -.-> export_AuthOAuthProviderId
export_AuthOAuthCompletionResult["AuthOAuthCompletionResult"]
module_src_auth_ts --> export_AuthOAuthCompletionResult
export_AuthOAuthConfig["AuthOAuthConfig"]
module_src_auth_ts --> export_AuthOAuthConfig
export_AuthOAuthConfig -.-> export_AuthOAuthProviderConfig
export_AuthOAuthError["AuthOAuthError"]
module_src_auth_ts --> export_AuthOAuthError
export_AuthOAuthError -.-> export_AuthOAuthProviderId
export_AuthOAuthErrorCode["AuthOAuthErrorCode"]
module_src_auth_ts --> export_AuthOAuthErrorCode
export_AuthOAuthErrorStage["AuthOAuthErrorStage"]
module_src_auth_ts --> export_AuthOAuthErrorStage
export_AuthOAuthProviderConfig["AuthOAuthProviderConfig"]
module_src_auth_ts --> export_AuthOAuthProviderConfig
export_AuthOAuthProviderConfig -.-> export_AuthOAuthProviderId
export_AuthOAuthProviderConfig -.-> export_IconSpec
export_AuthOAuthProviderId["AuthOAuthProviderId"]
module_src_auth_ts --> export_AuthOAuthProviderId
export_AuthOAuthRedirect["AuthOAuthRedirect"]
module_src_auth_ts --> export_AuthOAuthRedirect
export_AuthOAuthRedirect -.-> export_AuthOAuthProviderId
export_AuthOAuthStartResult["AuthOAuthStartResult"]
module_src_auth_ts --> export_AuthOAuthStartResult
export_AuthOAuthTransportCancellationReason["AuthOAuthTransportCancellationReason"]
module_src_auth_ts --> export_AuthOAuthTransportCancellationReason
export_AuthOAuthTransportError["AuthOAuthTransportError"]
module_src_auth_ts --> export_AuthOAuthTransportError
export_AuthOAuthTransportErrorCode["AuthOAuthTransportErrorCode"]
module_src_auth_ts --> export_AuthOAuthTransportErrorCode
export_AuthProfileCreateStrategy["AuthProfileCreateStrategy"]
module_src_types_ts --> export_AuthProfileCreateStrategy
export_AuthProfileField["AuthProfileField"]
Expand Down Expand Up @@ -299,8 +340,9 @@ graph LR
export_CollectionItemPressPayload["CollectionItemPressPayload"]
module_src_types_ts --> export_CollectionItemPressPayload
export_CollectionItemPressPayload -.-> export_ManifestValue
export_CompleteOAuthSignInInput["CompleteOAuthSignInInput"]
module_src_auth_ts --> export_CompleteOAuthSignInInput
export_CompleteOAuthAuthorizationInput["CompleteOAuthAuthorizationInput"]
module_src_auth_ts --> export_CompleteOAuthAuthorizationInput
export_CompleteOAuthAuthorizationInput -.-> export_AuthOAuthAuthorizationResponse
export_ComponentDataBinding["ComponentDataBinding"]
module_src_bindings_ts --> export_ComponentDataBinding
export_ComponentDataBinding -.-> export_EventBinding
Expand Down Expand Up @@ -551,6 +593,10 @@ graph LR
module_src_bindings_ts --> export_EventBindingTarget
export_FilterAction["FilterAction"]
module_src_types_ts --> export_FilterAction
export_findForbiddenInlineSecretFields["findForbiddenInlineSecretFields"]
module_src_secrets_ts --> export_findForbiddenInlineSecretFields
export_FORBIDDEN_INLINE_SECRET_FIELDS["FORBIDDEN_INLINE_SECRET_FIELDS"]
module_src_secrets_ts --> export_FORBIDDEN_INLINE_SECRET_FIELDS
export_FormSubmitEventDto["FormSubmitEventDto"]
module_src_types_ts --> export_FormSubmitEventDto
export_FormSubmitValues["FormSubmitValues"]
Expand All @@ -572,9 +618,13 @@ graph LR
export_InfraManifest -.-> export_AuthSpec
export_InfraManifest -.-> export_DatabaseSpec
export_InfraManifest -.-> export_DeploymentSpec
export_InfraManifest -.-> export_InfraSecretStoreSpec
export_InfraManifest -.-> export_NetworkingSpec
export_InfraManifest -.-> export_StateSpec
export_InfraManifest -.-> export_StorageSpec
export_InfraSecretStoreSpec["InfraSecretStoreSpec"]
module_src_secretManifest_ts --> export_InfraSecretStoreSpec
export_InfraSecretStoreSpec -.-> export_SecretStoreProvider
export_KnownAuthOAuthProviderId["KnownAuthOAuthProviderId"]
module_src_auth_ts --> export_KnownAuthOAuthProviderId
export_KnownAuthProfileField["KnownAuthProfileField"]
Expand All @@ -589,6 +639,8 @@ graph LR
module_src_types_ts --> export_KnownDatabaseProvider
export_KnownDeploymentTarget["KnownDeploymentTarget"]
module_src_types_ts --> export_KnownDeploymentTarget
export_KnownSecretStoreProvider["KnownSecretStoreProvider"]
module_src_secrets_ts --> export_KnownSecretStoreProvider
export_KnownStateProvider["KnownStateProvider"]
module_src_types_ts --> export_KnownStateProvider
export_ManagedApiDataSourceConfig["ManagedApiDataSourceConfig"]
Expand Down Expand Up @@ -616,6 +668,13 @@ graph LR
module_src_types_ts --> export_NavigatorType
export_NetworkingSpec["NetworkingSpec"]
module_src_types_ts --> export_NetworkingSpec
export_normalizeSecretRef["normalizeSecretRef"]
module_src_secrets_ts --> export_normalizeSecretRef
export_normalizeSecretRef -.-> export_SecretStoreResult
export_normalizeSecretScope["normalizeSecretScope"]
module_src_secrets_ts --> export_normalizeSecretScope
export_normalizeSecretScope -.-> export_SecretScope
export_normalizeSecretScope -.-> export_SecretStoreResult
export_NUTRITION_BARCODE_TYPES["NUTRITION_BARCODE_TYPES"]
module_src_nutrition_common_ts --> export_NUTRITION_BARCODE_TYPES
export_NUTRITION_CAPTURE_SUBMISSION_STATUSES["NUTRITION_CAPTURE_SUBMISSION_STATUSES"]
Expand Down Expand Up @@ -800,14 +859,63 @@ graph LR
export_ScreenSpec -.-> export_UiNode
export_SearchAction["SearchAction"]
module_src_types_ts --> export_SearchAction
export_SECRET_STORE_ERROR_CODES["SECRET_STORE_ERROR_CODES"]
module_src_secrets_ts --> export_SECRET_STORE_ERROR_CODES
export_SECRET_STORE_PROVIDERS["SECRET_STORE_PROVIDERS"]
module_src_secrets_ts --> export_SECRET_STORE_PROVIDERS
export_SecretCreateInput["SecretCreateInput"]
module_src_secrets_ts --> export_SecretCreateInput
export_SecretCreateInput -.-> export_SecretScope
export_SecretGetMetadataInput["SecretGetMetadataInput"]
module_src_secrets_ts --> export_SecretGetMetadataInput
export_SecretGetMetadataInput -.-> export_SecretScope
export_SecretListInput["SecretListInput"]
module_src_secrets_ts --> export_SecretListInput
export_SecretListInput -.-> export_SecretScope
export_SecretMetadata["SecretMetadata"]
module_src_secrets_ts --> export_SecretMetadata
export_SecretMetadata -.-> export_SecretScope
export_SecretPayload["SecretPayload"]
module_src_secrets_ts --> export_SecretPayload
export_SecretRef["SecretRef"]
module_src_secrets_ts --> export_SecretRef
export_SecretRemoveInput["SecretRemoveInput"]
module_src_secrets_ts --> export_SecretRemoveInput
export_SecretRemoveInput -.-> export_SecretScope
export_SecretReplaceInput["SecretReplaceInput"]
module_src_secrets_ts --> export_SecretReplaceInput
export_SecretReplaceInput -.-> export_SecretScope
export_SecretResolveInput["SecretResolveInput"]
module_src_secrets_ts --> export_SecretResolveInput
export_SecretResolveInput -.-> export_SecretScope
export_SecretScope["SecretScope"]
module_src_secrets_ts --> export_SecretScope
export_SecretStoreAdapter["SecretStoreAdapter"]
module_src_secrets_ts --> export_SecretStoreAdapter
export_SecretStoreAdapter -.-> export_SecretCreateInput
export_SecretStoreAdapter -.-> export_SecretGetMetadataInput
export_SecretStoreAdapter -.-> export_SecretListInput
export_SecretStoreAdapter -.-> export_SecretMetadata
export_SecretStoreAdapter -.-> export_SecretPayload
export_SecretStoreAdapter -.-> export_SecretRemoveInput
export_SecretStoreAdapter -.-> export_SecretReplaceInput
export_SecretStoreAdapter -.-> export_SecretResolveInput
export_SecretStoreAdapter -.-> export_SecretStoreResult
export_SecretStoreError["SecretStoreError"]
module_src_secrets_ts --> export_SecretStoreError
export_SecretStoreErrorCode["SecretStoreErrorCode"]
module_src_secrets_ts --> export_SecretStoreErrorCode
export_SecretStoreOkResult["SecretStoreOkResult"]
module_src_secrets_ts --> export_SecretStoreOkResult
export_SecretStoreProvider["SecretStoreProvider"]
module_src_secrets_ts --> export_SecretStoreProvider
export_SecretStoreResult["SecretStoreResult"]
module_src_secrets_ts --> export_SecretStoreResult
export_SetLanguageAction["SetLanguageAction"]
module_src_types_ts --> export_SetLanguageAction
export_SignInInput["SignInInput"]
module_src_auth_ts --> export_SignInInput
export_SignInInput -.-> export_AuthIdentifier
export_SignInWithOAuthInput["SignInWithOAuthInput"]
module_src_auth_ts --> export_SignInWithOAuthInput
export_SignInWithOAuthInput -.-> export_AuthOAuthProviderId
export_SignOutInput["SignOutInput"]
module_src_auth_ts --> export_SignOutInput
export_SignUpInput["SignUpInput"]
Expand All @@ -825,6 +933,9 @@ graph LR
module_src_types_ts --> export_SplashScreenSpec
export_SplashScreenSpec -.-> export_SplashScreenModeSpec
export_SplashScreenSpec -.-> export_SplashScreenResizeMode
export_StartOAuthAuthorizationInput["StartOAuthAuthorizationInput"]
module_src_auth_ts --> export_StartOAuthAuthorizationInput
export_StartOAuthAuthorizationInput -.-> export_AuthOAuthProviderId
export_STATE_PERSISTENCE_MODES["STATE_PERSISTENCE_MODES"]
module_src_types_ts --> export_STATE_PERSISTENCE_MODES
export_STATE_PROVIDERS["STATE_PROVIDERS"]
Expand Down Expand Up @@ -995,6 +1106,9 @@ graph LR
export_UrlImageAssetSource["UrlImageAssetSource"]
module_src_storage_ts --> export_UrlImageAssetSource
export_UrlImageAssetSource -.-> export_ImageMetadata
export_validateSecretPayload["validateSecretPayload"]
module_src_secrets_ts --> export_validateSecretPayload
export_validateSecretPayload -.-> export_SecretStoreResult
export_VerifyOtpInput["VerifyOtpInput"]
module_src_auth_ts --> export_VerifyOtpInput
export_VerifyOtpInput -.-> export_AuthIdentifier
4 changes: 4 additions & 0 deletions paradox/diagrams/module-relationships.mmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,13 @@ graph LR
module_src_nutrition_review_ts["src/nutrition/review.ts"]
module_src_requirements_ts["src/requirements.ts"]
module_src_runtimeCallbacks_ts["src/runtimeCallbacks.ts"]
module_src_secretManifest_ts["src/secretManifest.ts"]
module_src_secrets_ts["src/secrets.ts"]
module_src_state_ts["src/state.ts"]
module_src_storage_ts["src/storage.ts"]
module_src_types_ts["src/types.ts"]
module_src_ui_ts["src/ui.ts"]
module_src_auth_ts --> module_src_secrets_ts
module_src_auth_ts --> module_src_types_ts
module_src_bindings_ts --> module_src_data_index_ts
module_src_data_apis_ts --> module_src_data_operations_ts
Expand Down Expand Up @@ -56,6 +59,7 @@ graph LR
module_src_nutrition_review_ts --> module_src_nutrition_common_ts
module_src_nutrition_review_ts --> module_src_nutrition_products_ts
module_src_runtimeCallbacks_ts --> module_src_types_ts
module_src_secretManifest_ts --> module_src_secrets_ts
module_src_types_ts --> module_src_auth_ts
module_src_types_ts --> module_src_bindings_ts
module_src_types_ts --> module_src_data_index_ts
Expand Down
Loading
Loading