@oxy.so/contracts 5.3.0 → 5.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/accountGraph.js +2 -1
- package/dist/cjs/client/accountGraph.js +12 -0
- package/dist/cjs/client/index.js +6 -5
- package/dist/cjs/index.js +25 -15
- package/dist/cjs/sessionRevocation.js +89 -0
- package/dist/esm/accountGraph.js +1 -1
- package/dist/esm/client/accountGraph.js +11 -0
- package/dist/esm/client/index.js +1 -1
- package/dist/esm/index.js +2 -1
- package/dist/esm/sessionRevocation.js +86 -0
- package/dist/types/accountGraph.d.ts +7 -7
- package/dist/types/client/accountGraph.d.ts +15 -7
- package/dist/types/client/index.d.ts +1 -1
- package/dist/types/index.d.ts +3 -1
- package/dist/types/sessionRevocation.d.ts +100 -0
- package/package.json +1 -1
package/dist/cjs/accountGraph.js
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
* {@link ACCOUNT_CATEGORY_IDS} for the four rules that govern it.
|
|
9
9
|
*/
|
|
10
10
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
11
|
-
exports.createAccountRequestSchema = exports.accountNameSchema = exports.accountCategoriesSchema = exports.accountCategoryIdSchema = exports.childAccountKindSchema = exports.accountKindSchema = exports.kindAcceptsAccountCategories = exports.ACCOUNT_CATEGORY_KINDS = exports.MAX_ACCOUNT_CATEGORIES = exports.newlyAddedRetiredCategories = exports.SELECTABLE_ACCOUNT_CATEGORY_IDS = exports.isSelectableAccountCategoryId = exports.RETIRED_ACCOUNT_CATEGORY_IDS = exports.ACCOUNT_CATEGORY_IDS = exports.isAccountKind = exports.isOperatorSwitchTargetKind = exports.isDelegatedActAsEligibleKind = exports.CHILD_ACCOUNT_KINDS = exports.ACCOUNT_KINDS = void 0;
|
|
11
|
+
exports.createAccountRequestSchema = exports.accountNameSchema = exports.accountCategoriesSchema = exports.accountCategoryIdSchema = exports.childAccountKindSchema = exports.accountKindSchema = exports.kindAcceptsAccountCategories = exports.ACCOUNT_CATEGORY_KINDS = exports.MAX_ACCOUNT_CATEGORIES = exports.newlyAddedRetiredCategories = exports.SELECTABLE_ACCOUNT_CATEGORY_IDS = exports.isSelectableAccountCategoryId = exports.RETIRED_ACCOUNT_CATEGORY_IDS = exports.ACCOUNT_CATEGORY_IDS = exports.isAccountKind = exports.isMemberOperatedKind = exports.isOperatorSwitchTargetKind = exports.isDelegatedActAsEligibleKind = exports.CHILD_ACCOUNT_KINDS = exports.ACCOUNT_KINDS = void 0;
|
|
12
12
|
const zod_1 = require("zod");
|
|
13
13
|
const avatarCharacter_1 = require("./avatarCharacter");
|
|
14
14
|
const accountName_1 = require("./accountName");
|
|
@@ -23,6 +23,7 @@ Object.defineProperty(exports, "ACCOUNT_KINDS", { enumerable: true, get: functio
|
|
|
23
23
|
Object.defineProperty(exports, "CHILD_ACCOUNT_KINDS", { enumerable: true, get: function () { return accountGraph_2.CHILD_ACCOUNT_KINDS; } });
|
|
24
24
|
Object.defineProperty(exports, "isDelegatedActAsEligibleKind", { enumerable: true, get: function () { return accountGraph_2.isDelegatedActAsEligibleKind; } });
|
|
25
25
|
Object.defineProperty(exports, "isOperatorSwitchTargetKind", { enumerable: true, get: function () { return accountGraph_2.isOperatorSwitchTargetKind; } });
|
|
26
|
+
Object.defineProperty(exports, "isMemberOperatedKind", { enumerable: true, get: function () { return accountGraph_2.isMemberOperatedKind; } });
|
|
26
27
|
Object.defineProperty(exports, "isAccountKind", { enumerable: true, get: function () { return accountGraph_2.isAccountKind; } });
|
|
27
28
|
Object.defineProperty(exports, "ACCOUNT_CATEGORY_IDS", { enumerable: true, get: function () { return accountGraph_2.ACCOUNT_CATEGORY_IDS; } });
|
|
28
29
|
Object.defineProperty(exports, "RETIRED_ACCOUNT_CATEGORY_IDS", { enumerable: true, get: function () { return accountGraph_2.RETIRED_ACCOUNT_CATEGORY_IDS; } });
|
|
@@ -8,6 +8,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
8
8
|
exports.ACCOUNT_CATEGORY_KINDS = exports.MAX_ACCOUNT_CATEGORIES = exports.SELECTABLE_ACCOUNT_CATEGORY_IDS = exports.RETIRED_ACCOUNT_CATEGORY_IDS = exports.ACCOUNT_CATEGORY_IDS = exports.CHILD_ACCOUNT_KINDS = exports.ACCOUNT_KINDS = void 0;
|
|
9
9
|
exports.isDelegatedActAsEligibleKind = isDelegatedActAsEligibleKind;
|
|
10
10
|
exports.isOperatorSwitchTargetKind = isOperatorSwitchTargetKind;
|
|
11
|
+
exports.isMemberOperatedKind = isMemberOperatedKind;
|
|
11
12
|
exports.isAccountKind = isAccountKind;
|
|
12
13
|
exports.isSelectableAccountCategoryId = isSelectableAccountCategoryId;
|
|
13
14
|
exports.newlyAddedRetiredCategories = newlyAddedRetiredCategories;
|
|
@@ -37,6 +38,7 @@ exports.CHILD_ACCOUNT_KINDS = [
|
|
|
37
38
|
'project',
|
|
38
39
|
'bot',
|
|
39
40
|
'channel',
|
|
41
|
+
'community',
|
|
40
42
|
];
|
|
41
43
|
/**
|
|
42
44
|
* Whether an account of this kind may be the SUBJECT OF A DELEGATION — an
|
|
@@ -107,6 +109,16 @@ function isDelegatedActAsEligibleKind(kind) {
|
|
|
107
109
|
function isOperatorSwitchTargetKind(kind) {
|
|
108
110
|
return kind === 'organization' || kind === 'project';
|
|
109
111
|
}
|
|
112
|
+
/**
|
|
113
|
+
* Whether an account of this kind is OPERATED BY ITS MEMBERS rather than acted
|
|
114
|
+
* as: a `channel` (its members write as it) or a `community` (its members are
|
|
115
|
+
* its moderators). Neither can be the subject of a session or a delegation
|
|
116
|
+
* ({@link isDelegatedActAsEligibleKind} refuses both), so there is no right
|
|
117
|
+
* stronger than active membership to ask for, and membership is the whole of it.
|
|
118
|
+
*/
|
|
119
|
+
function isMemberOperatedKind(kind) {
|
|
120
|
+
return kind === 'channel' || kind === 'community';
|
|
121
|
+
}
|
|
110
122
|
/**
|
|
111
123
|
* Narrow an unknown value to an {@link AccountKind}.
|
|
112
124
|
*
|
package/dist/cjs/client/index.js
CHANGED
|
@@ -30,11 +30,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
30
30
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
31
31
|
};
|
|
32
32
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
33
|
-
exports.
|
|
34
|
-
exports.
|
|
35
|
-
exports.
|
|
36
|
-
exports.
|
|
37
|
-
exports.appAttestKeyResponseCheck = void 0;
|
|
33
|
+
exports.signedRecordEnvelopeCheck = exports.externalIdentityReferenceCheck = exports.loginResultCheck = exports.isLoopbackOrigin = exports.executeAgentKeyOperationCheck = exports.agentVerifyRequestCheck = exports.agentProofClaimsCheck = exports.agentKeyOperationResultCheck = exports.agentKeyOperationCheck = exports.agentKeyOperationChallengeCheck = exports.agentKeyListResponseCheck = exports.agentChallengeRequestCheck = exports.AGENT_PROOF_TTL_MS = exports.AGENT_PROOF_AUDIENCE = exports.AGENT_PROOF_ACTIONS = exports.ACCOUNT_AUTH_METHODS = exports.emailVerificationStartResponseCheck = exports.emailVerificationConfirmResponseCheck = exports.emailTicketCheck = exports.emailAddressCheck = exports.EMAIL_VERIFICATION_PURPOSES = exports.EMAIL_VERIFICATION_ERROR_CODES = exports.EMAIL_TICKET_TTL_MS = exports.EMAIL_CODE_TTL_MS = exports.EMAIL_CODE_MAX_ATTEMPTS = exports.EMAIL_CODE_LENGTH = exports.isPlainTextTitle = exports.accountTitleCheck = exports.accountNamePolicyForKind = exports.ACCOUNT_TITLE_MAX_LENGTH = exports.ACCOUNT_TITLE_DISALLOWED_SOURCE = exports.ACCOUNT_NAME_POLICY_BY_KIND = exports.newlyAddedRetiredCategories = exports.kindAcceptsAccountCategories = exports.isSelectableAccountCategoryId = exports.isOperatorSwitchTargetKind = exports.isMemberOperatedKind = exports.isDelegatedActAsEligibleKind = exports.isAccountKind = exports.SELECTABLE_ACCOUNT_CATEGORY_IDS = exports.RETIRED_ACCOUNT_CATEGORY_IDS = exports.MAX_ACCOUNT_CATEGORIES = exports.CHILD_ACCOUNT_KINDS = exports.ACCOUNT_KINDS = exports.ACCOUNT_CATEGORY_KINDS = exports.ACCOUNT_CATEGORY_IDS = exports.parseContract = exports.formatCheckPath = exports.checkContract = exports.ContractCheckError = void 0;
|
|
34
|
+
exports.updateOrganizationCheck = exports.organizationNameCheck = exports.organizationListCheck = exports.organizationImportBatchResultCheck = exports.organizationExternalResolutionCheck = exports.organizationExternalCheck = exports.organizationCurationResultCheck = exports.organizationClaimReviewCheck = exports.organizationClaimListCheck = exports.organizationClaimInputCheck = exports.organizationClaimDetailCheck = exports.organizationClaimCheck = exports.organizationCheck = exports.organizationBatchCheck = exports.createOrganizationCheck = exports.ORGANIZATION_TYPES = exports.ORGANIZATION_STATUSES = exports.ORGANIZATION_NAME_MAX_LENGTH = exports.ORGANIZATION_ERROR_CODES = exports.ORGANIZATION_CLAIM_STATUSES = exports.ORGANIZATION_CLAIM_DECISIONS = exports.ORGANIZATION_ALIAS_KINDS = exports.canonicalJson = exports.buildIdentityProofMessage = exports.IDENTITY_PROOF_VERSION = exports.IDENTITY_PROOF_DOMAIN = exports.IDENTITY_PROOF_CHALLENGE_TTL_MS = exports.IDENTITY_PROOF_AUDIENCE = exports.IDENTITY_PROOF_ACTION_VALUES = exports.IDENTITY_PROOF_ACTIONS = exports.IDENTITY_ERROR_CODES = exports.parseIdentityLinkQrPayload = exports.identityLinkStateCheck = exports.identityLinkCreateResponseCheck = exports.buildIdentityLinkQrPayload = exports.IDENTITY_LINK_STATUSES = exports.IDENTITY_LINK_QR_PREFIX = exports.sessionAccountsChangedEventCheck = exports.deviceTokenMintResponseCheck = exports.deviceSessionSyncCheck = exports.deviceSessionStateCheck = exports.deviceRegisterResponseCheck = exports.deviceJoinResponseCheck = exports.deviceJoinCodeResponseCheck = exports.deviceBackgroundCredentialResponseCheck = exports.activeTokenCheck = exports.SESSION_ACCOUNTS_CHANGED_EVENT = exports.deviceDirectorySyncCheck = exports.deviceDirectoryCheck = exports.deviceActivateResponseCheck = void 0;
|
|
35
|
+
exports.TOTP_DIGITS = exports.TOTP_BACKUP_CODE_COUNT = exports.SIGN_IN_ERROR_CODES = exports.SIGNIN_SECOND_FACTOR_TTL_MS = exports.SIGNIN_SECOND_FACTOR_MAX_ATTEMPTS = exports.REAUTH_ACTIONS = exports.PASSWORD_MIN_LENGTH = exports.PASSWORD_MAX_LENGTH = exports.EMAIL_SIGNIN_LONG_CODE_LENGTH = exports.EMAIL_SIGNIN_LONG_CODE_ALPHABET = exports.EMAIL_SIGNIN_LINK_TTL_MS = exports.EMAIL_SIGNIN_CHOICE_TTL_MS = exports.EMAIL_ACCOUNTS_MAX = exports.publicApplicationCheck = exports.supervisionStateCheck = exports.supervisionReviewInputCheck = exports.supervisionInviteInputCheck = exports.supervisionInvitationCheck = exports.supervisionContactsResponseCheck = exports.supervisionContactInputCheck = exports.supervisionAcceptInputCheck = exports.safetyPeopleResponseCheck = exports.safetyPeopleInputCheck = exports.safetyOrganizationsResponseCheck = exports.safetyOrganizationsInputCheck = exports.purchaseReviewInputCheck = exports.purchaseApprovalListCheck = exports.purchaseApprovalCheck = exports.profileAccessInputCheck = exports.profileAccessDecisionCheck = exports.SUPERVISION_STATUSES = exports.SUPERVISION_INVITATION_STATUSES = exports.SUPERVISION_CONSENT_VERSION = exports.SUPERVISED_ACTIONS = exports.SAFETY_POLICY_VERSION = exports.PURCHASE_APPROVAL_STATUSES = exports.isFullReputationBalance = exports.recommendationRequestCheck = exports.subscriptionCreditGrantsResponseCheck = exports.subjectProductAccessQueryCheck = exports.subjectProductAccessCheck = exports.productSubscriptionsResponseCheck = exports.productSubscriptionRenewalRequestCheck = exports.productSubscriptionCancellationResultCheck = exports.productPlanCheckoutRequestCheck = exports.productPlanCatalogueCheck = exports.personalPlanCheckoutResultCheck = exports.personalPlanCheckoutRequestCheck = exports.personalPlanCatalogueCheck = exports.cancelProductSubscriptionCheck = void 0;
|
|
36
|
+
exports.appAssertionChallengeResponseCheck = exports.OXY_APP_ASSERTION_TYPE = exports.OXY_APP_ASSERTION_TTL_SECONDS = exports.OXY_APP_ASSERTION_HEADER = exports.OXY_APP_ASSERTION_AUDIENCE = exports.APP_ASSERTION_PLATFORMS = exports.APP_ASSERTION_ERROR_CODES = exports.APP_ASSERTION_CHALLENGE_PURPOSES = exports.isRightsClaim = exports.isErasureRequest = exports.OPEN_CONTENT_CLAIM_STATES = exports.ERASURE_REQUEST_DEADLINE_DAYS = exports.COUNTER_NOTICE_STATEMENTS = exports.COUNTER_NOTICE_STATEMENT_VERSION = exports.CONTENT_CLAIM_STATES = exports.CONTENT_CLAIM_REFERENCE_PATTERN = exports.CONTENT_CLAIM_LIMITS = exports.CONTENT_CLAIM_KINDS = exports.CONTENT_CLAIM_ERROR_CODES = exports.CONTENT_CLAIM_COUNTER_NOTICE_LIMITS = exports.CLOSED_CONTENT_CLAIM_STATES = exports.CLAIMANT_RELATIONSHIPS = exports.userNameCheck = exports.usernameCheckForAccountKind = exports.usernameCheck = exports.stripDisallowedUsernameCharacters = exports.botUsernameCheck = exports.applyBotUsernameSuffix = exports.USERNAME_PATTERN_SOURCE = exports.USERNAME_MIN_LENGTH = exports.USERNAME_MAX_LENGTH = exports.USERNAME_INVALID_MESSAGE = exports.RESERVED_USERNAME_MESSAGE = exports.RESERVED_USERNAMES = exports.NUMERIC_USERNAME_MESSAGE = exports.BOT_USERNAME_SUFFIX = exports.BOT_USERNAME_INVALID_MESSAGE = exports.totpEnrollResponseCheck = exports.totpBackupCodesResponseCheck = exports.signInMethodsCheck = exports.secondFactorRequiredCheck = exports.reauthProofCheck = exports.normalizeEmailSignInCode = exports.isSecondFactorRequired = exports.isEmailSignInChooseAccount = exports.emailSignInStartResponseCheck = exports.emailSignInPendingCheck = exports.emailSignInLinkResponseCheck = exports.emailSignInChooseAccountCheck = exports.TOTP_PERIOD_SECONDS = void 0;
|
|
37
|
+
exports.appAttestKeyResponseCheck = exports.appAssertionResponseCheck = void 0;
|
|
38
38
|
var check_1 = require("./check");
|
|
39
39
|
Object.defineProperty(exports, "ContractCheckError", { enumerable: true, get: function () { return check_1.ContractCheckError; } });
|
|
40
40
|
Object.defineProperty(exports, "checkContract", { enumerable: true, get: function () { return check_1.checkContract; } });
|
|
@@ -50,6 +50,7 @@ Object.defineProperty(exports, "RETIRED_ACCOUNT_CATEGORY_IDS", { enumerable: tru
|
|
|
50
50
|
Object.defineProperty(exports, "SELECTABLE_ACCOUNT_CATEGORY_IDS", { enumerable: true, get: function () { return accountGraph_1.SELECTABLE_ACCOUNT_CATEGORY_IDS; } });
|
|
51
51
|
Object.defineProperty(exports, "isAccountKind", { enumerable: true, get: function () { return accountGraph_1.isAccountKind; } });
|
|
52
52
|
Object.defineProperty(exports, "isDelegatedActAsEligibleKind", { enumerable: true, get: function () { return accountGraph_1.isDelegatedActAsEligibleKind; } });
|
|
53
|
+
Object.defineProperty(exports, "isMemberOperatedKind", { enumerable: true, get: function () { return accountGraph_1.isMemberOperatedKind; } });
|
|
53
54
|
Object.defineProperty(exports, "isOperatorSwitchTargetKind", { enumerable: true, get: function () { return accountGraph_1.isOperatorSwitchTargetKind; } });
|
|
54
55
|
Object.defineProperty(exports, "isSelectableAccountCategoryId", { enumerable: true, get: function () { return accountGraph_1.isSelectableAccountCategoryId; } });
|
|
55
56
|
Object.defineProperty(exports, "kindAcceptsAccountCategories", { enumerable: true, get: function () { return accountGraph_1.kindAcceptsAccountCategories; } });
|
package/dist/cjs/index.js
CHANGED
|
@@ -25,21 +25,21 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
25
25
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
26
26
|
};
|
|
27
27
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
28
|
-
exports.
|
|
29
|
-
exports.
|
|
30
|
-
exports.
|
|
31
|
-
exports.
|
|
32
|
-
exports.
|
|
33
|
-
exports.
|
|
34
|
-
exports.
|
|
35
|
-
exports.
|
|
36
|
-
exports.
|
|
37
|
-
exports.
|
|
38
|
-
exports.
|
|
39
|
-
exports.
|
|
40
|
-
exports.
|
|
41
|
-
exports.
|
|
42
|
-
exports.FREE_USER_PROFILE_COLOR_PRESETS = exports.USER_PROFILE_COLOR_PRESETS = exports.USER_PROFILE_COLORS = exports.serviceTokenOptionsSchema = exports.serviceTokenScopesSchema = exports.productPlanCatalogueSchema = exports.personalPlanCatalogueSchema = exports.personalPlanDisplayPriceSchema = exports.productSubscriptionCancellationResultSchema = void 0;
|
|
28
|
+
exports.USERNAME_MAX_LENGTH = exports.USERNAME_MIN_LENGTH = exports.applyBotUsernameSuffix = exports.stripDisallowedUsernameCharacters = exports.isValidUsername = exports.usernameSchemaForAccountKind = exports.usernameSchema = exports.financialEffectAttributionSchema = exports.attributeFinancialEffect = exports.accountKindActsAsItself = exports.accountKindActorNature = exports.accountActorNatureSchema = exports.accountActorChainSchema = exports.accountActorChainFromSession = exports.KIND_INDEPENDENT_ACCOUNT_DIMENSIONS = exports.FINANCIAL_EFFECT_DIRECTIONS = exports.ACCOUNT_SUBJECT_CONTRACT_VERSION = exports.ACCOUNT_ACTOR_NATURES = exports.parseAvatarCharacter = exports.avatarCharacterSchema = exports.avatarCharacterFor = exports.AVATAR_PICKABLE_SHAPES = exports.AVATAR_PICKABLE_COLORS = exports.AVATAR_EYE_SPACING = exports.isPlainTextTitle = exports.accountTitleSchema = exports.accountNamePolicyForKind = exports.ACCOUNT_TITLE_MAX_LENGTH = exports.ACCOUNT_TITLE_DISALLOWED_SOURCE = exports.ACCOUNT_NAME_POLICY_BY_KIND = exports.accountNameSchema = exports.createAccountRequestSchema = exports.SELECTABLE_ACCOUNT_CATEGORY_IDS = exports.RETIRED_ACCOUNT_CATEGORY_IDS = exports.newlyAddedRetiredCategories = exports.MAX_ACCOUNT_CATEGORIES = exports.kindAcceptsAccountCategories = exports.isSelectableAccountCategoryId = exports.accountCategoryIdSchema = exports.accountCategoriesSchema = exports.ACCOUNT_CATEGORY_KINDS = exports.ACCOUNT_CATEGORY_IDS = exports.isMemberOperatedKind = exports.isOperatorSwitchTargetKind = exports.isDelegatedActAsEligibleKind = exports.isAccountKind = exports.childAccountKindSchema = exports.CHILD_ACCOUNT_KINDS = exports.accountKindSchema = exports.ACCOUNT_KINDS = void 0;
|
|
29
|
+
exports.appAffinityEventsIngestSchema = exports.appAffinityEventSchema = exports.appAffinityEventTypeSchema = exports.appUserSignalIngestSchema = exports.appInterestInputSchema = exports.appEndorsementInputSchema = exports.recommendationResponseSchema = exports.recommendationItemSchema = exports.recommendationCountSchema = exports.recommendationRequestSchema = exports.recommendationSignalWeightsSchema = exports.recommendationBoostSchema = exports.recommendationExcludeTypeSchema = exports.oxyServiceEventsHeartbeatSchema = exports.oxySessionRevocationEventSchema = exports.OXY_SERVICE_EVENTS_FORBIDDEN = exports.OXY_SERVICE_EVENTS_STALE_AFTER_MS = exports.OXY_SERVICE_EVENTS_HEARTBEAT_MS = exports.OXY_SERVICE_EVENTS_HEARTBEAT_EVENT = exports.OXY_SESSION_REVOKED_EVENT = exports.OXY_SERVICE_EVENTS_NAMESPACE = exports.oxyUserInvalidationEventSchema = exports.isPublishedOxyUserChangeReason = exports.OXY_PUBLISHED_USER_CHANGE_REASONS = exports.OXY_USER_CHANGE_REASONS = exports.OXY_USER_INVALIDATION_CHANNEL = exports.inboxEmailPushDataSchema = exports.INBOX_EMAIL_PUSH_TYPE = exports.INBOX_EMAIL_PUSH_CHANNEL = exports.IDENTITY_APPROVAL_PUSH_CHANNEL = exports.commonsDenyReasonSchema = exports.COMMONS_DENY_REASONS = exports.sessionStatusSchema = exports.publicApplicationSchema = exports.applicationTypeSchema = exports.safeParseContract = exports.resolveUserId = exports.deviceLinkedSessionsResponseSchema = exports.deviceLinkedSessionSchema = exports.currentUserResponseSchema = exports.userProfileUpdateSchema = exports.userResponseSchema = exports.dateOfBirthSchema = exports.themePreferenceSchema = exports.userRelationshipSchema = exports.userNameSchema = exports.NUMERIC_USERNAME_MESSAGE = exports.RESERVED_USERNAME_MESSAGE = exports.BOT_USERNAME_INVALID_MESSAGE = exports.USERNAME_INVALID_MESSAGE = void 0;
|
|
30
|
+
exports.reputationBalanceBreakdownSchema = exports.reputationTransactionSchema = exports.reputationInfluenceContextSchema = exports.reputationTargetEntityTypeSchema = exports.trustTierSchema = exports.reputationTransactionStatusSchema = exports.reputationCategorySchema = exports.REPUTATION_INFLUENCE_CONTEXTS = exports.REPUTATION_TARGET_ENTITY_TYPES = exports.TRUST_TIERS = exports.REPUTATION_TRANSACTION_STATUSES = exports.REPUTATION_CATEGORIES = exports.credentialVerifyResultSchema = exports.credentialListResultSchema = exports.credentialIssueResultSchema = exports.verifiableCredentialResponseSchema = exports.credentialRecordSchema = exports.vouchResultSchema = exports.personhoodStatusResultSchema = exports.personhoodBreakdownSchema = exports.personhoodVouchRecordSchema = exports.validationVoteResultSchema = exports.validationRequestSummarySchema = exports.validationOpenResultSchema = exports.validationOpenRequestSchema = exports.validationVerdictRecordSchema = exports.realLifeAttestationResultSchema = exports.realLifeAttestationRecordSchema = exports.signedPublicCardSchema = exports.publicCardSchema = exports.logPageResponseSchema = exports.chainHeadResponseSchema = exports.oxySignedRecordTypeSchema = exports.exportBundleSchema = exports.exportFinancialSectionSchema = exports.exportUsageReservationSchema = exports.exportLedgerEntrySchema = exports.exportUsageReceiptSchema = exports.exportAttestationSchema = exports.authMethodsResponseSchema = exports.authMethodEntrySchema = exports.domainVerificationInstructionsSchema = exports.resourceDomainOwnershipResponseSchema = exports.resourceDomainOwnershipRequestSchema = exports.domainVerificationRequestSchema = exports.verifiedDomainSchema = exports.signedRecordEnvelopeSchema = exports.didDocumentSchema = exports.didServiceSchema = exports.verificationMethodSchema = void 0;
|
|
31
|
+
exports.identityBindingSchema = exports.registerIdentityBindingSchema = exports.reverseModerationEffectResultSchema = exports.applyModerationDecisionResultSchema = exports.moderationEffectSchema = exports.reverseModerationEffectSchema = exports.finalizeModerationDecisionSchema = exports.moderationDecisionEventSchema = exports.moderationPolicyVersionsSchema = exports.moderationDecisionEventSubjectSchema = exports.moderationFindingSchema = exports.applicationModerationStandingSchema = exports.identityBindingStatusSchema = exports.identityBindingTypeSchema = exports.personhoodStatusSchema = exports.contributionTierSchema = exports.conductStandingSchema = exports.conductStrikeStatusSchema = exports.moderationEffectSkipReasonSchema = exports.moderationEffectStatusSchema = exports.moderationEffectTypeSchema = exports.moderationDecisionStatusSchema = exports.moderationAttributionSchema = exports.moderationFindingScopeSchema = exports.moderationSeveritySchema = exports.APPLICATION_MODERATION_STANDINGS = exports.IDENTITY_BINDING_STATUSES = exports.IDENTITY_BINDING_TYPES = exports.PERSONHOOD_STATUSES = exports.CONTRIBUTION_TIERS = exports.CONDUCT_STANDINGS = exports.CONDUCT_STRIKE_STATUSES = exports.MODERATION_EFFECT_SKIP_REASONS = exports.MODERATION_EFFECT_STATUSES = exports.MODERATION_EFFECT_TYPES = exports.MODERATION_DECISION_STATUSES = exports.MODERATION_ATTRIBUTIONS = exports.MODERATION_FINDING_SCOPES = exports.MODERATION_SEVERITIES = exports.isFullReputationBalance = exports.awardReputationSchema = exports.reputationInfluenceResultSchema = exports.reputationLeaderboardEntrySchema = exports.reputationLeaderboardUserSchema = exports.reputationRulesResponseSchema = exports.reputationRuleSchema = exports.reputationBalanceSchema = exports.reputationBalanceSummarySchema = exports.reputationReliabilitySchema = exports.reputationInfluenceSchema = void 0;
|
|
32
|
+
exports.IDENTITY_PROOF_DOMAIN = exports.IDENTITY_PROOF_VERSION = exports.backupStatusResponseSchema = exports.backupUploadRequestSchema = exports.encryptedBackupEnvelopeSchema = exports.backupLookupIdSchema = exports.rotateKeyCompleteResponseSchema = exports.rotateKeyCompleteRequestSchema = exports.rotateKeyChallengeResponseSchema = exports.loginResultSchema = exports.mcpOAuthConsentResponseSchema = exports.mcpOAuthClientInfoResponseSchema = exports.mcpOAuthConsentContextSchema = exports.mcpOAuthWriteActionSchema = exports.mcpOAuthClientApplicationSchema = exports.oauthAuthorizeCodeResponseSchema = exports.oauthConsentDecisionSchema = exports.deviceDirectorySyncSchema = exports.deviceActivateResponseSchema = exports.deviceActivateRequestSchema = exports.deviceDirectorySchema = exports.devicePrincipalSchema = exports.deviceAccountContextSchema = exports.deviceDirectoryProfileSchema = exports.deviceContextRelationshipSchema = exports.sessionAccountsChangedEventSchema = exports.sessionAccountsChangedReasonSchema = exports.SESSION_ACCOUNTS_CHANGED_EVENT = exports.deviceJoinResponseSchema = exports.deviceJoinRequestSchema = exports.deviceJoinCodeResponseSchema = exports.deviceJoinCodeRequestSchema = exports.deviceRegisterResponseSchema = exports.deviceProofSchema = exports.deviceBackgroundTokenResponseSchema = exports.deviceBackgroundTokenRequestSchema = exports.deviceBackgroundCredentialResponseSchema = exports.deviceTokenMintResponseSchema = exports.deviceTokenMintRequestSchema = exports.deviceSessionSyncSchema = exports.activeTokenSchema = exports.deviceSessionStateSchema = exports.sessionAccountSchema = exports.applicationModerationTrustSchema = exports.reputationContextualInfluenceSchema = exports.reputationReviewingSchema = exports.reputationReportingSchema = exports.reputationConductSchema = exports.reputationContributionSchema = exports.reputationPersonhoodSchema = void 0;
|
|
33
|
+
exports.EMAIL_SIGNIN_LINK_TTL_MS = exports.emailVerificationConfirmResponseSchema = exports.emailVerificationConfirmRequestSchema = exports.emailVerificationStartResponseSchema = exports.emailVerificationStartRequestSchema = exports.emailTicketSchema = exports.emailAddressSchema = exports.EMAIL_VERIFICATION_ERROR_CODES = exports.EMAIL_TICKET_TTL_MS = exports.EMAIL_CODE_MAX_ATTEMPTS = exports.EMAIL_CODE_TTL_MS = exports.EMAIL_CODE_LENGTH = exports.EMAIL_VERIFICATION_PURPOSES = exports.updateRolloutPatchSchema = exports.promoteRequestSchema = exports.rollbackToEmbeddedRequestSchema = exports.rollbackRequestSchema = exports.updateListResponseSchema = exports.channelListResponseSchema = exports.channelSchema = exports.rollbackToEmbeddedEntrySchema = exports.createUpdateResponseSchema = exports.updateSchema = exports.createUpdateRequestSchema = exports.updateAssetRefSchema = exports.assetCompleteResponseSchema = exports.assetCompleteResultItemSchema = exports.assetCompleteRequestSchema = exports.assetInitResponseSchema = exports.assetUploadTicketSchema = exports.assetInitRequestSchema = exports.assetInitItemSchema = exports.rolloutPercentSchema = exports.runtimeVersionSchema = exports.channelNameSchema = exports.sha256HexSchema = exports.updateAssetStatusSchema = exports.updateStatusSchema = exports.updatePlatformSchema = exports.identityRootStatusSchema = exports.identityProofChallengeResponseSchema = exports.identityProofChallengeRequestSchema = exports.identityProofSchema = exports.buildIdentityProofMessage = exports.canonicalJson = exports.IDENTITY_ERROR_CODES = exports.IDENTITY_PROOF_ACTION_VALUES = exports.IDENTITY_PROOF_ACTIONS = exports.IDENTITY_PROOF_CHALLENGE_TTL_MS = exports.IDENTITY_PROOF_AUDIENCE = void 0;
|
|
34
|
+
exports.buildIdentityLinkQrPayload = exports.identityLinkIdSchema = exports.IDENTITY_LINK_QR_PREFIX = exports.IDENTITY_LINK_STATUSES = exports.totpBackupCodesResponseSchema = exports.totpReauthRequestSchema = exports.totpConfirmRequestSchema = exports.totpEnrollResponseSchema = exports.signInMethodsSchema = exports.emailSetRequestSchema = exports.emailChangeStartRequestSchema = exports.signInMethodRemoveRequestSchema = exports.passwordSetRequestSchema = exports.reauthEmailStartRequestSchema = exports.REAUTH_ACTIONS = exports.reauthProofSchema = exports.isSecondFactorRequired = exports.signUpRequestSchema = exports.secondFactorRequiredSchema = exports.secondFactorSignInRequestSchema = exports.passwordSignInRequestSchema = exports.isEmailSignInChooseAccount = exports.emailSignInChooseRequestSchema = exports.emailSignInChooseAccountSchema = exports.emailSignInAccountOptionSchema = exports.EMAIL_ACCOUNTS_MAX = exports.EMAIL_SIGNIN_CHOICE_TTL_MS = exports.emailSignInPendingSchema = exports.emailSignInLinkResponseSchema = exports.emailSignInLinkRequestSchema = exports.emailSignInCollectRequestSchema = exports.EMAIL_SIGNIN_LONG_CODE_LENGTH = exports.EMAIL_SIGNIN_LONG_CODE_ALPHABET = exports.normalizeEmailSignInCode = exports.emailSignInCodeSchema = exports.emailSignInConfirmRequestSchema = exports.emailSignInStartResponseSchema = exports.emailSignInStartRequestSchema = exports.secondFactorCodeSchema = exports.newPasswordSchema = exports.passwordInputSchema = exports.signInIdentifierSchema = exports.SIGN_IN_ERROR_CODES = exports.TOTP_BACKUP_CODE_COUNT = exports.TOTP_PERIOD_SECONDS = exports.TOTP_DIGITS = exports.PASSWORD_MAX_LENGTH = exports.PASSWORD_MIN_LENGTH = exports.SIGNIN_SECOND_FACTOR_MAX_ATTEMPTS = exports.SIGNIN_SECOND_FACTOR_TTL_MS = void 0;
|
|
35
|
+
exports.inferenceAttributionSchema = exports.authenticatedPrincipalSchema = exports.billingPrincipalSchema = exports.inferenceScopeSchema = exports.INFERENCE_SCOPES = exports.unitPriceSchema = exports.usageQuantitySchema = exports.usageSourceSchema = exports.USAGE_SOURCES = exports.usageUnitSchema = exports.USAGE_UNITS = exports.moneySchema = exports.exactDecimalSchema = exports.INFERENCE_MONEY_SCALE = exports.currencyCodeSchema = exports.RESERVED_ALIA_PUBLISHER = exports.inferenceFundingTierSchema = exports.inferenceRegionSchema = exports.deploymentIdSchema = exports.inferenceProviderSlugSchema = exports.routingProfileSlugSchema = exports.routingProfileIdSchema = exports.modelReferenceSchema = exports.modelRevisionLabelSchema = exports.modelIdSchema = exports.modelSlugSchema = exports.publisherSlugSchema = exports.sha256DigestSchema = exports.inferenceHttpsUrlSchema = exports.inferenceDateSchema = exports.inferenceTimestampSchema = exports.inferenceEnvironmentSchema = exports.idempotencyKeySchema = exports.generationIdSchema = exports.requestIdSchema = exports.oxyCredentialIdSchema = exports.oxyApplicationIdSchema = exports.delegatedUserIdSchema = exports.oxyAccountIdSchema = exports.INFERENCE_CONTRACT_VERSION = exports.transparencyCheckpointListSchema = exports.transparencyInclusionProofSchema = exports.transparencyCheckpointSchema = exports.transparencyAnchorSchema = exports.transparencyCheckpointSignatureSchema = exports.identityLinkCompleteRequestSchema = exports.identityLinkProofRequestSchema = exports.identityLinkStateSchema = exports.identityLinkCreateResponseSchema = exports.parseIdentityLinkQrPayload = void 0;
|
|
36
|
+
exports.authorizedRouteSchema = exports.effectiveSameModelDeployment = exports.routingPolicyReferenceSchema = exports.routingPolicySchema = exports.routingFallbackPolicySchema = exports.routingPolicyScopeSchema = exports.routingTargetSchema = exports.modelCatalogueEntrySchema = exports.catalogueServingProviderSummarySchema = exports.cataloguePublisherSummarySchema = exports.routingProfileSchema = exports.routingProfileCandidateSchema = exports.modelDeploymentSchema = exports.inferenceProviderSchema = exports.modelRevisionSchema = exports.catalogueModelSchema = exports.modelPublisherSchema = exports.modelSafetyMetadataSchema = exports.modelEvaluationResultSchema = exports.modelDeprecationSchema = exports.commercialPermissionSchema = exports.availabilityScopeSchema = exports.inferenceDataPolicySchema = exports.modelProvenanceSchema = exports.modelLicenseSchema = exports.modelCapabilitiesSchema = exports.modelRealtimeCapabilitiesSchema = exports.realtimeSessionTransportSchema = exports.realtimeSessionKindSchema = exports.inferenceApiFormatSchema = exports.modelPowerClassSchema = exports.powerLevelSchema = exports.reasoningEffortSchema = exports.inferenceOutputModalitySchema = exports.inferenceModalitySchema = exports.priceSnapshotSchema = exports.priceVersionSchema = exports.priceVersionStatusSchema = exports.embeddingResponseSchema = exports.embeddingFailureSchema = exports.embeddingSuccessSchema = exports.embeddingUsageSchema = exports.embeddingVectorSchema = exports.inferenceErrorSchema = exports.providerErrorPassthroughSchema = exports.safeErrorTextSchema = exports.upstreamErrorCategorySchema = exports.inferenceErrorCodeSchema = exports.NON_RETRYABLE_INFERENCE_ERROR_CODES = exports.INFERENCE_ERROR_CODES = void 0;
|
|
37
|
+
exports.realtimeAudioFormatSchema = exports.realtimeResponseIdSchema = exports.realtimeItemIdSchema = exports.realtimeCommandIdSchema = exports.MAX_REALTIME_RESUME_WINDOW_MS = exports.MAX_REALTIME_SESSION_AUDIO_BYTES = exports.MAX_REALTIME_SESSION_DURATION_MS = exports.MAX_REALTIME_AUDIO_FRAME_BASE64_LENGTH = exports.inferenceStreamEventSchema = exports.inferenceStreamDoneEventSchema = exports.inferenceFinishReasonSchema = exports.inferenceStreamErrorEventSchema = exports.inferenceStreamRouteSwitchEventSchema = exports.inferenceRouteSwitchReasonSchema = exports.inferenceRouteSwitchDetailSchema = exports.inferenceStreamUsageEventSchema = exports.inferenceStreamToolCallEventSchema = exports.inferenceStreamAudioEventSchema = exports.MAX_INFERENCE_AUDIO_BYTES = exports.inferenceAudioMediaTypeSchema = exports.inferenceStreamDeltaEventSchema = exports.inferenceStreamStartEventSchema = exports.inferenceAudioOutputParametersSchema = exports.inferenceSpeechParametersSchema = exports.inferenceRequestSchema = exports.clientRequestMetadataSchema = exports.responseFormatSchema = exports.toolChoiceSchema = exports.toolDefinitionSchema = exports.inferenceReasoningSchema = exports.samplingParametersSchema = exports.inferenceInputSchema = exports.inferenceMessageSchema = exports.inferenceMessageRoleSchema = exports.inferenceToolCallSchema = exports.inferenceContentPartSchema = exports.inferenceContentSourceSchema = exports.modelDocumentationSchema = exports.modelReleaseIngestionResultSchema = exports.modelReleaseIngestionRequestSchema = exports.modelLineDeclarationSchema = exports.modelGpaiDocumentationSchema = exports.modelDownstreamDocumentationSchema = exports.SYSTEMIC_RISK_COMPUTE_THRESHOLD_FLOPS = exports.trainingComputeFlopsSchema = exports.modelSystemicRiskTierSchema = exports.modelDistributionMethodSchema = exports.aliaModelReleaseManifestSchema = exports.aliaReleaseSignatureSchema = exports.aliaReleaseArtifactSchema = void 0;
|
|
38
|
+
exports.realtimeServerEventSchema = exports.realtimeSessionClosedEventSchema = exports.realtimeSessionCloseReasonSchema = exports.realtimeErrorEventSchema = exports.realtimeResponseDoneEventSchema = exports.realtimeResponseStatusSchema = exports.realtimeToolCallEventSchema = exports.realtimeTextDeltaEventSchema = exports.realtimeTranscriptDoneEventSchema = exports.realtimeTranscriptDeltaEventSchema = exports.realtimeTranscriptSourceSchema = exports.realtimeOutputAudioDoneEventSchema = exports.realtimeOutputAudioDeltaEventSchema = exports.realtimeResponseCreatedEventSchema = exports.realtimeInputAudioClearedEventSchema = exports.realtimeInputAudioCommittedEventSchema = exports.realtimeSpeechStoppedEventSchema = exports.realtimeSpeechStartedEventSchema = exports.realtimeItemTruncatedEventSchema = exports.realtimeItemDeletedEventSchema = exports.realtimeItemDoneEventSchema = exports.realtimeItemAddedEventSchema = exports.realtimeCommandAcceptedEventSchema = exports.realtimeSessionResumedEventSchema = exports.realtimeSessionUpdatedEventSchema = exports.realtimeSessionCreatedEventSchema = exports.realtimeClientCommandSchema = exports.realtimeSessionCloseCommandSchema = exports.realtimeSessionResumeCommandSchema = exports.realtimeResponseCancelCommandSchema = exports.realtimeResponseCreateCommandSchema = exports.realtimeInputAudioClearCommandSchema = exports.realtimeInputAudioCommitCommandSchema = exports.realtimeInputAudioAppendCommandSchema = exports.realtimeItemTruncateCommandSchema = exports.realtimeItemDeleteCommandSchema = exports.realtimeItemCreateCommandSchema = exports.realtimeSessionUpdateCommandSchema = exports.realtimeResponseParametersSchema = exports.realtimeConversationItemSchema = exports.realtimeContentPartSchema = exports.realtimeSessionRequestSchema = exports.realtimeClientMetadataSchema = exports.realtimeSessionLimitsSchema = exports.realtimeSessionConfigUpdateSchema = exports.realtimeSessionConfigSchema = exports.realtimeTranslationSchema = exports.realtimeInputTranscriptionSchema = exports.realtimeTurnDetectionSchema = exports.realtimeOutputModalitySchema = void 0;
|
|
39
|
+
exports.externalPaymentSchema = exports.externalPaymentKindSchema = exports.EXTERNAL_PAYMENT_KINDS = exports.externalPaymentProviderSchema = exports.EXTERNAL_PAYMENT_PROVIDERS = exports.billingInvoiceSchema = exports.billingInvoiceStatusSchema = exports.BILLING_INVOICE_STATUSES = exports.accountBillingStateSchema = exports.billingProfileSchema = exports.autoRechargeSchema = exports.billingProfileStatusSchema = exports.BILLING_PROFILE_STATUSES = exports.billingModeSchema = exports.BILLING_MODES = exports.providerConnectionSchema = exports.providerConnectionStatusSchema = exports.providerConnectionValidationSchema = exports.providerCredentialCustodyStateSchema = exports.providerCredentialValidationDeploymentSchema = exports.providerCredentialValidationOperationSchema = exports.kaanaCredentialValidationOutcomeSchema = exports.kaanaCredentialValidationFailureCodeSchema = exports.kaanaCredentialValidationOutcomeStateSchema = exports.kaanaCredentialValidationTaskSchema = exports.kaanaCredentialOutcomeSchema = exports.kaanaCredentialConflictOutcomeSchema = exports.kaanaCredentialAppliedOutcomeSchema = exports.kaanaCredentialOutcomeRequestSchema = exports.kaanaCredentialRevokeOutcomeRequestSchema = exports.kaanaCredentialRotateOutcomeRequestSchema = exports.kaanaCredentialCreateOutcomeRequestSchema = exports.kaanaCredentialMutationSchema = exports.kaanaCredentialRevokeMutationSchema = exports.kaanaCredentialRotateMutationSchema = exports.kaanaCredentialCreateMutationSchema = exports.kaanaCredentialIdentitySchema = exports.kaanaCredentialOperationActionSchema = exports.kaanaCredentialOperationIdSchema = exports.kaanaCredentialHandleSchema = exports.providerConnectionScopeSchema = exports.usageRefundSchema = exports.usageRefundReasonSchema = exports.usageRefundSubjectSchema = exports.usageReceiptSchema = exports.normalizedUsageReportSchema = exports.inferenceRequestOutcomeSchema = exports.usageReservationSchema = exports.usageReservationStatusSchema = exports.usageReservationRequestSchema = void 0;
|
|
40
|
+
exports.automationTriggerSchema = exports.agentAvailabilitySchema = exports.applicationAgentSchema = exports.applicationAgentWriteSchema = exports.applicationAgentAvailabilitySchema = exports.APPLICATION_AGENT_AVAILABILITIES = exports.agentRequesterCeilingSchema = exports.agentRequesterCeilingWriteSchema = exports.AGENT_REQUESTER_CEILING_AUTONOMY = exports.delegationGrantSchema = exports.capabilityTicketRequestSchema = exports.capabilityCoordinatorSchema = exports.executionAuthorizationRefSchema = exports.capabilityCatalogBindingSchema = exports.grantLimitSchema = exports.toolGrantOverrideSchema = exports.resourceRefSchema = exports.foregroundExecutionAuthorizationInputSchema = exports.executionActorRefSchema = exports.actorRefSchema = exports.capabilityPackageSchema = exports.autonomyLevelSchema = exports.CAPABILITY_PACKAGES = exports.AUTONOMY_LEVELS = exports.costCenterUsageSchema = exports.providerCostSourceSchema = exports.PROVIDER_COST_SOURCES = exports.inferenceEconomicTreatmentSchema = exports.INFERENCE_ECONOMIC_TREATMENTS = exports.productEntitlementSchema = exports.costCenterSpendSchema = exports.costCenterSchema = exports.costCenterStatusSchema = exports.COST_CENTER_STATUSES = exports.payAsYouGoEntitlementSchema = exports.productPlanSchema = exports.planAllowanceSchema = exports.LIVE_PRODUCT_PLAN_STATUSES = exports.productPlanStatusSchema = exports.PRODUCT_PLAN_STATUSES = exports.reconciliationReportSchema = exports.reconciliationRunSchema = exports.reconciliationDiscrepancySchema = exports.reconciliationRunStatusSchema = exports.RECONCILIATION_RUN_STATUSES = exports.reconciliationDiscrepancyKindSchema = exports.RECONCILIATION_DISCREPANCY_KINDS = exports.autoRechargeAttemptSchema = exports.autoRechargeStatusSchema = exports.AUTO_RECHARGE_STATUSES = void 0;
|
|
41
|
+
exports.subjectProductAccessSchema = exports.productOfferSegmentSchema = exports.subjectProductGrantSnapshotSchema = exports.productAccessGrantSchema = exports.productSubscriptionSourceSchema = exports.productOfferSchema = exports.productBenefitSchema = exports.subjectProductAccessQuerySchema = exports.productDefinitionSchema = exports.inboxInferenceStreamEventSchema = exports.inboxThreadSummaryResponseSchema = exports.inboxSmartRepliesResponseSchema = exports.inboxNaturalSearchResponseSchema = exports.inboxInferenceTextResponseSchema = exports.inboxMessageInferenceParamsSchema = exports.inboxNaturalSearchRequestSchema = exports.INBOX_DAILY_BRIEF_SECTIONS = exports.inboxDailyBriefResponseSchema = exports.inboxDailyBriefRequestSchema = exports.inboxComposeRequestSchema = exports.emailAgentContextSchema = exports.emailContextMessageSchema = exports.emailContextMailboxSchema = exports.emailContextAddressSchema = exports.resolveCatalogInvocation = exports.matchCatalogInvocation = exports.findOverlappingCatalogInvocations = exports.catalogInvocationTemplatesEquivalent = exports.catalogInvocationsOverlap = exports.catalogInvocationPathParameters = exports.normalizedAppEventSchema = exports.catalogRegistrationSchema = exports.appCapabilityCatalogSchema = exports.CATALOG_INTERNAL_TRANSPORTS = exports.catalogFeatureSchema = exports.catalogEventSchema = exports.catalogToolSchema = exports.catalogToolAllowsActor = exports.catalogToolActors = exports.catalogToolActorTypeSchema = exports.CATALOG_TOOL_DEFAULT_ACTORS = exports.CATALOG_TOOL_ACTOR_TYPES = exports.auditEventSchema = exports.auditResultSchema = exports.policyDecisionSchema = exports.invocationPrincipalSchema = exports.capabilityTicketClaimsSchema = exports.automationDefinitionSchema = exports.automationDataFlowSchema = exports.automationActorSelectionSchema = void 0;
|
|
42
|
+
exports.FREE_USER_PROFILE_COLOR_PRESETS = exports.USER_PROFILE_COLOR_PRESETS = exports.USER_PROFILE_COLORS = exports.serviceTokenOptionsSchema = exports.serviceTokenScopesSchema = exports.productPlanCatalogueSchema = exports.personalPlanCatalogueSchema = exports.personalPlanDisplayPriceSchema = exports.productSubscriptionCancellationResultSchema = exports.cancelProductSubscriptionSchema = exports.subscriptionCreditGrantsResponseSchema = exports.subscriptionCreditGrantSchema = exports.productSubscriptionsResponseSchema = exports.productSubscriptionSummarySchema = exports.isLoopbackOrigin = exports.inputSatisfiesCapabilityLimits = exports.canonicalCapabilityJson = exports.meteredGenerationSchema = void 0;
|
|
43
43
|
var accountGraph_1 = require("./accountGraph");
|
|
44
44
|
Object.defineProperty(exports, "ACCOUNT_KINDS", { enumerable: true, get: function () { return accountGraph_1.ACCOUNT_KINDS; } });
|
|
45
45
|
Object.defineProperty(exports, "accountKindSchema", { enumerable: true, get: function () { return accountGraph_1.accountKindSchema; } });
|
|
@@ -48,6 +48,7 @@ Object.defineProperty(exports, "childAccountKindSchema", { enumerable: true, get
|
|
|
48
48
|
Object.defineProperty(exports, "isAccountKind", { enumerable: true, get: function () { return accountGraph_1.isAccountKind; } });
|
|
49
49
|
Object.defineProperty(exports, "isDelegatedActAsEligibleKind", { enumerable: true, get: function () { return accountGraph_1.isDelegatedActAsEligibleKind; } });
|
|
50
50
|
Object.defineProperty(exports, "isOperatorSwitchTargetKind", { enumerable: true, get: function () { return accountGraph_1.isOperatorSwitchTargetKind; } });
|
|
51
|
+
Object.defineProperty(exports, "isMemberOperatedKind", { enumerable: true, get: function () { return accountGraph_1.isMemberOperatedKind; } });
|
|
51
52
|
Object.defineProperty(exports, "ACCOUNT_CATEGORY_IDS", { enumerable: true, get: function () { return accountGraph_1.ACCOUNT_CATEGORY_IDS; } });
|
|
52
53
|
Object.defineProperty(exports, "ACCOUNT_CATEGORY_KINDS", { enumerable: true, get: function () { return accountGraph_1.ACCOUNT_CATEGORY_KINDS; } });
|
|
53
54
|
Object.defineProperty(exports, "accountCategoriesSchema", { enumerable: true, get: function () { return accountGraph_1.accountCategoriesSchema; } });
|
|
@@ -134,6 +135,15 @@ Object.defineProperty(exports, "OXY_USER_CHANGE_REASONS", { enumerable: true, ge
|
|
|
134
135
|
Object.defineProperty(exports, "OXY_PUBLISHED_USER_CHANGE_REASONS", { enumerable: true, get: function () { return userInvalidation_1.OXY_PUBLISHED_USER_CHANGE_REASONS; } });
|
|
135
136
|
Object.defineProperty(exports, "isPublishedOxyUserChangeReason", { enumerable: true, get: function () { return userInvalidation_1.isPublishedOxyUserChangeReason; } });
|
|
136
137
|
Object.defineProperty(exports, "oxyUserInvalidationEventSchema", { enumerable: true, get: function () { return userInvalidation_1.oxyUserInvalidationEventSchema; } });
|
|
138
|
+
var sessionRevocation_1 = require("./sessionRevocation");
|
|
139
|
+
Object.defineProperty(exports, "OXY_SERVICE_EVENTS_NAMESPACE", { enumerable: true, get: function () { return sessionRevocation_1.OXY_SERVICE_EVENTS_NAMESPACE; } });
|
|
140
|
+
Object.defineProperty(exports, "OXY_SESSION_REVOKED_EVENT", { enumerable: true, get: function () { return sessionRevocation_1.OXY_SESSION_REVOKED_EVENT; } });
|
|
141
|
+
Object.defineProperty(exports, "OXY_SERVICE_EVENTS_HEARTBEAT_EVENT", { enumerable: true, get: function () { return sessionRevocation_1.OXY_SERVICE_EVENTS_HEARTBEAT_EVENT; } });
|
|
142
|
+
Object.defineProperty(exports, "OXY_SERVICE_EVENTS_HEARTBEAT_MS", { enumerable: true, get: function () { return sessionRevocation_1.OXY_SERVICE_EVENTS_HEARTBEAT_MS; } });
|
|
143
|
+
Object.defineProperty(exports, "OXY_SERVICE_EVENTS_STALE_AFTER_MS", { enumerable: true, get: function () { return sessionRevocation_1.OXY_SERVICE_EVENTS_STALE_AFTER_MS; } });
|
|
144
|
+
Object.defineProperty(exports, "OXY_SERVICE_EVENTS_FORBIDDEN", { enumerable: true, get: function () { return sessionRevocation_1.OXY_SERVICE_EVENTS_FORBIDDEN; } });
|
|
145
|
+
Object.defineProperty(exports, "oxySessionRevocationEventSchema", { enumerable: true, get: function () { return sessionRevocation_1.oxySessionRevocationEventSchema; } });
|
|
146
|
+
Object.defineProperty(exports, "oxyServiceEventsHeartbeatSchema", { enumerable: true, get: function () { return sessionRevocation_1.oxyServiceEventsHeartbeatSchema; } });
|
|
137
147
|
var recommendations_1 = require("./recommendations");
|
|
138
148
|
// Schemas
|
|
139
149
|
Object.defineProperty(exports, "recommendationExcludeTypeSchema", { enumerable: true, get: function () { return recommendations_1.recommendationExcludeTypeSchema; } });
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Canonical contract for the session-revocation feed: oxy-api telling every
|
|
4
|
+
* connected Oxy backend that a session stopped being valid.
|
|
5
|
+
*
|
|
6
|
+
* WHY IT EXISTS. `@oxy.so/core/server` reuses a successful bearer validation on
|
|
7
|
+
* a backend for a short TTL, because an app backend cannot verify a user access
|
|
8
|
+
* token itself (HS256 under a secret only oxy-api holds) and asking Oxy on every
|
|
9
|
+
* request put ~300 ms on every authenticated route. A cache like that is only
|
|
10
|
+
* safe if it hears about revocations the moment they happen. This feed is how it
|
|
11
|
+
* hears: oxy-api announces every session it ends — logout, sign-out-all, device
|
|
12
|
+
* removal, an account switched away from, an admin or operator revocation, a
|
|
13
|
+
* credential change that ends sessions, account deletion or archive — and the
|
|
14
|
+
* SDK drops what it cached for that session or user.
|
|
15
|
+
*
|
|
16
|
+
* THE TRANSPORT IS THE SDK's. A backend opens no Redis client and wires nothing:
|
|
17
|
+
* `OxyServer` connects to the {@link OXY_SERVICE_EVENTS_NAMESPACE} Socket.IO
|
|
18
|
+
* namespace on oxy-api with its own service token, and uses its validation cache
|
|
19
|
+
* ONLY while that connection is live (connected, and a
|
|
20
|
+
* {@link OXY_SERVICE_EVENTS_HEARTBEAT_EVENT} seen within
|
|
21
|
+
* {@link OXY_SERVICE_EVENTS_STALE_AFTER_MS}). Disconnected, stale or never
|
|
22
|
+
* connected, it validates every request against Oxy. So a lost connection costs
|
|
23
|
+
* latency, never correctness.
|
|
24
|
+
*
|
|
25
|
+
* DELIVERY. A revocation is announced after the write that ended the session
|
|
26
|
+
* committed. Between oxy-api tasks it rides Valkey pub/sub, which is
|
|
27
|
+
* at-most-once; the heartbeat is what makes a silent loss of the path visible —
|
|
28
|
+
* a task emits it only while its own Valkey round trip works — so a consumer
|
|
29
|
+
* stops trusting its cache when the path stops working, instead of trusting it
|
|
30
|
+
* forever.
|
|
31
|
+
*
|
|
32
|
+
* PRIVACY — the payload carries ids and a timestamp only. Only Oxy's own
|
|
33
|
+
* (internal-tier) services may join the namespace, and even so nothing a
|
|
34
|
+
* consumer could render is ever placed on it.
|
|
35
|
+
*
|
|
36
|
+
* Platform-agnostic — zod only, no react/react-native/expo.
|
|
37
|
+
*/
|
|
38
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
+
exports.oxyServiceEventsHeartbeatSchema = exports.oxySessionRevocationEventSchema = exports.OXY_SERVICE_EVENTS_FORBIDDEN = exports.OXY_SERVICE_EVENTS_STALE_AFTER_MS = exports.OXY_SERVICE_EVENTS_HEARTBEAT_MS = exports.OXY_SERVICE_EVENTS_HEARTBEAT_EVENT = exports.OXY_SESSION_REVOKED_EVENT = exports.OXY_SERVICE_EVENTS_NAMESPACE = void 0;
|
|
40
|
+
const zod_1 = require("zod");
|
|
41
|
+
/** The Socket.IO namespace on oxy-api that carries service events. */
|
|
42
|
+
exports.OXY_SERVICE_EVENTS_NAMESPACE = '/service-events';
|
|
43
|
+
/** One session (or every session of one user) stopped being valid. */
|
|
44
|
+
exports.OXY_SESSION_REVOKED_EVENT = 'session:revoked';
|
|
45
|
+
/**
|
|
46
|
+
* Emitted on connect and then every {@link OXY_SERVICE_EVENTS_HEARTBEAT_MS}
|
|
47
|
+
* while the emitting oxy-api task can still hear revocations (its Valkey
|
|
48
|
+
* subscription round-trips). Carries `{ at }`, the task's epoch-ms clock.
|
|
49
|
+
*/
|
|
50
|
+
exports.OXY_SERVICE_EVENTS_HEARTBEAT_EVENT = 'heartbeat';
|
|
51
|
+
/** How often a live oxy-api task sends {@link OXY_SERVICE_EVENTS_HEARTBEAT_EVENT}. */
|
|
52
|
+
exports.OXY_SERVICE_EVENTS_HEARTBEAT_MS = 5000;
|
|
53
|
+
/**
|
|
54
|
+
* How long a consumer keeps trusting the feed after the last heartbeat. Past
|
|
55
|
+
* this the feed counts as down: every cached validation is dropped and nothing
|
|
56
|
+
* is cached until heartbeats resume.
|
|
57
|
+
*/
|
|
58
|
+
exports.OXY_SERVICE_EVENTS_STALE_AFTER_MS = 12000;
|
|
59
|
+
/**
|
|
60
|
+
* The `connect_error` message oxy-api answers a caller that may never join the
|
|
61
|
+
* namespace (not a service token, or not an internal-tier application). A
|
|
62
|
+
* consumer stops retrying quickly on it; any other refusal is retried.
|
|
63
|
+
*/
|
|
64
|
+
exports.OXY_SERVICE_EVENTS_FORBIDDEN = 'service_events_forbidden';
|
|
65
|
+
/**
|
|
66
|
+
* A session revocation.
|
|
67
|
+
*
|
|
68
|
+
* - With `sessionId`: that one session ended. `userId` is the account it spoke
|
|
69
|
+
* as.
|
|
70
|
+
* - Without `sessionId`: every session of `userId` ended, or may have — the
|
|
71
|
+
* account was deleted or archived, or signed out everywhere. A consumer drops
|
|
72
|
+
* everything it holds for that account, including sessions it operated as a
|
|
73
|
+
* delegate.
|
|
74
|
+
*
|
|
75
|
+
* `at` is the publisher's epoch-ms clock: diagnostic only (propagation delay),
|
|
76
|
+
* never used for ordering — the event says "ask Oxy again", which is idempotent.
|
|
77
|
+
*/
|
|
78
|
+
exports.oxySessionRevocationEventSchema = zod_1.z.object({
|
|
79
|
+
/** The session that ended; absent for a revocation of every session of `userId`. */
|
|
80
|
+
sessionId: zod_1.z.string().min(1).max(256).optional(),
|
|
81
|
+
/** The account the session (or sessions) spoke as. */
|
|
82
|
+
userId: zod_1.z.string().min(1).max(256),
|
|
83
|
+
/** Publisher's epoch-ms timestamp. Diagnostic only. */
|
|
84
|
+
at: zod_1.z.number().int().nonnegative(),
|
|
85
|
+
});
|
|
86
|
+
/** The heartbeat payload. */
|
|
87
|
+
exports.oxyServiceEventsHeartbeatSchema = zod_1.z.object({
|
|
88
|
+
at: zod_1.z.number().int().nonnegative(),
|
|
89
|
+
});
|
package/dist/esm/accountGraph.js
CHANGED
|
@@ -15,7 +15,7 @@ import { usernameSchema, usernameSchemaForAccountKind } from './username.js';
|
|
|
15
15
|
// The Zod-free half of this contract lives in `./client/` (`@oxy.so/contracts/client`);
|
|
16
16
|
// it is re-exported here so the root entry is unchanged.
|
|
17
17
|
import { ACCOUNT_KINDS, CHILD_ACCOUNT_KINDS, ACCOUNT_CATEGORY_IDS, MAX_ACCOUNT_CATEGORIES, } from './client/accountGraph.js';
|
|
18
|
-
export { ACCOUNT_KINDS, CHILD_ACCOUNT_KINDS, isDelegatedActAsEligibleKind, isOperatorSwitchTargetKind, isAccountKind, ACCOUNT_CATEGORY_IDS, RETIRED_ACCOUNT_CATEGORY_IDS, isSelectableAccountCategoryId, SELECTABLE_ACCOUNT_CATEGORY_IDS, newlyAddedRetiredCategories, MAX_ACCOUNT_CATEGORIES, ACCOUNT_CATEGORY_KINDS, kindAcceptsAccountCategories, } from './client/accountGraph.js';
|
|
18
|
+
export { ACCOUNT_KINDS, CHILD_ACCOUNT_KINDS, isDelegatedActAsEligibleKind, isOperatorSwitchTargetKind, isMemberOperatedKind, isAccountKind, ACCOUNT_CATEGORY_IDS, RETIRED_ACCOUNT_CATEGORY_IDS, isSelectableAccountCategoryId, SELECTABLE_ACCOUNT_CATEGORY_IDS, newlyAddedRetiredCategories, MAX_ACCOUNT_CATEGORIES, ACCOUNT_CATEGORY_KINDS, kindAcceptsAccountCategories, } from './client/accountGraph.js';
|
|
19
19
|
export const accountKindSchema = z.enum(ACCOUNT_KINDS);
|
|
20
20
|
export const childAccountKindSchema = z.enum(CHILD_ACCOUNT_KINDS);
|
|
21
21
|
/**
|
|
@@ -28,6 +28,7 @@ export const CHILD_ACCOUNT_KINDS = [
|
|
|
28
28
|
'project',
|
|
29
29
|
'bot',
|
|
30
30
|
'channel',
|
|
31
|
+
'community',
|
|
31
32
|
];
|
|
32
33
|
/**
|
|
33
34
|
* Whether an account of this kind may be the SUBJECT OF A DELEGATION — an
|
|
@@ -98,6 +99,16 @@ export function isDelegatedActAsEligibleKind(kind) {
|
|
|
98
99
|
export function isOperatorSwitchTargetKind(kind) {
|
|
99
100
|
return kind === 'organization' || kind === 'project';
|
|
100
101
|
}
|
|
102
|
+
/**
|
|
103
|
+
* Whether an account of this kind is OPERATED BY ITS MEMBERS rather than acted
|
|
104
|
+
* as: a `channel` (its members write as it) or a `community` (its members are
|
|
105
|
+
* its moderators). Neither can be the subject of a session or a delegation
|
|
106
|
+
* ({@link isDelegatedActAsEligibleKind} refuses both), so there is no right
|
|
107
|
+
* stronger than active membership to ask for, and membership is the whole of it.
|
|
108
|
+
*/
|
|
109
|
+
export function isMemberOperatedKind(kind) {
|
|
110
|
+
return kind === 'channel' || kind === 'community';
|
|
111
|
+
}
|
|
101
112
|
/**
|
|
102
113
|
* Narrow an unknown value to an {@link AccountKind}.
|
|
103
114
|
*
|
package/dist/esm/client/index.js
CHANGED
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
* here; import them from `@oxy.so/contracts` with `import type`.
|
|
16
16
|
*/
|
|
17
17
|
export { ContractCheckError, checkContract, formatCheckPath, parseContract, } from './check.js';
|
|
18
|
-
export { ACCOUNT_CATEGORY_IDS, ACCOUNT_CATEGORY_KINDS, ACCOUNT_KINDS, CHILD_ACCOUNT_KINDS, MAX_ACCOUNT_CATEGORIES, RETIRED_ACCOUNT_CATEGORY_IDS, SELECTABLE_ACCOUNT_CATEGORY_IDS, isAccountKind, isDelegatedActAsEligibleKind, isOperatorSwitchTargetKind, isSelectableAccountCategoryId, kindAcceptsAccountCategories, newlyAddedRetiredCategories, } from './accountGraph.js';
|
|
18
|
+
export { ACCOUNT_CATEGORY_IDS, ACCOUNT_CATEGORY_KINDS, ACCOUNT_KINDS, CHILD_ACCOUNT_KINDS, MAX_ACCOUNT_CATEGORIES, RETIRED_ACCOUNT_CATEGORY_IDS, SELECTABLE_ACCOUNT_CATEGORY_IDS, isAccountKind, isDelegatedActAsEligibleKind, isMemberOperatedKind, isOperatorSwitchTargetKind, isSelectableAccountCategoryId, kindAcceptsAccountCategories, newlyAddedRetiredCategories, } from './accountGraph.js';
|
|
19
19
|
export { ACCOUNT_NAME_POLICY_BY_KIND, ACCOUNT_TITLE_DISALLOWED_SOURCE, ACCOUNT_TITLE_MAX_LENGTH, accountNamePolicyForKind, accountTitleCheck, isPlainTextTitle, } from './accountName.js';
|
|
20
20
|
export { EMAIL_CODE_LENGTH, EMAIL_CODE_MAX_ATTEMPTS, EMAIL_CODE_TTL_MS, EMAIL_TICKET_TTL_MS, EMAIL_VERIFICATION_ERROR_CODES, EMAIL_VERIFICATION_PURPOSES, emailAddressCheck, emailTicketCheck, emailVerificationConfirmResponseCheck, emailVerificationStartResponseCheck, } from './accountEmail.js';
|
|
21
21
|
export { ACCOUNT_AUTH_METHODS, AGENT_PROOF_ACTIONS, AGENT_PROOF_AUDIENCE, AGENT_PROOF_TTL_MS, agentChallengeRequestCheck, agentKeyListResponseCheck, agentKeyOperationChallengeCheck, agentKeyOperationCheck, agentKeyOperationResultCheck, agentProofClaimsCheck, agentVerifyRequestCheck, executeAgentKeyOperationCheck, } from './agentKeys.js';
|
package/dist/esm/index.js
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* Platform-agnostic — zod is the only runtime dependency. No react/react-native/
|
|
10
10
|
* expo, no `require()` in the ESM build.
|
|
11
11
|
*/
|
|
12
|
-
export { ACCOUNT_KINDS, accountKindSchema, CHILD_ACCOUNT_KINDS, childAccountKindSchema, isAccountKind, isDelegatedActAsEligibleKind, isOperatorSwitchTargetKind, ACCOUNT_CATEGORY_IDS, ACCOUNT_CATEGORY_KINDS, accountCategoriesSchema, accountCategoryIdSchema, isSelectableAccountCategoryId, kindAcceptsAccountCategories, MAX_ACCOUNT_CATEGORIES, newlyAddedRetiredCategories, RETIRED_ACCOUNT_CATEGORY_IDS, SELECTABLE_ACCOUNT_CATEGORY_IDS, createAccountRequestSchema, accountNameSchema, } from './accountGraph.js';
|
|
12
|
+
export { ACCOUNT_KINDS, accountKindSchema, CHILD_ACCOUNT_KINDS, childAccountKindSchema, isAccountKind, isDelegatedActAsEligibleKind, isOperatorSwitchTargetKind, isMemberOperatedKind, ACCOUNT_CATEGORY_IDS, ACCOUNT_CATEGORY_KINDS, accountCategoriesSchema, accountCategoryIdSchema, isSelectableAccountCategoryId, kindAcceptsAccountCategories, MAX_ACCOUNT_CATEGORIES, newlyAddedRetiredCategories, RETIRED_ACCOUNT_CATEGORY_IDS, SELECTABLE_ACCOUNT_CATEGORY_IDS, createAccountRequestSchema, accountNameSchema, } from './accountGraph.js';
|
|
13
13
|
export { ACCOUNT_NAME_POLICY_BY_KIND, ACCOUNT_TITLE_DISALLOWED_SOURCE, ACCOUNT_TITLE_MAX_LENGTH, accountNamePolicyForKind, accountTitleSchema, isPlainTextTitle, } from './accountName.js';
|
|
14
14
|
export { AVATAR_EYE_SPACING, AVATAR_PICKABLE_COLORS, AVATAR_PICKABLE_SHAPES, avatarCharacterFor, avatarCharacterSchema, parseAvatarCharacter, } from './avatarCharacter.js';
|
|
15
15
|
export { ACCOUNT_ACTOR_NATURES, ACCOUNT_SUBJECT_CONTRACT_VERSION, FINANCIAL_EFFECT_DIRECTIONS, KIND_INDEPENDENT_ACCOUNT_DIMENSIONS, accountActorChainFromSession, accountActorChainSchema, accountActorNatureSchema, accountKindActorNature, accountKindActsAsItself, attributeFinancialEffect, financialEffectAttributionSchema, } from './accountSubject.js';
|
|
@@ -29,6 +29,7 @@ export {
|
|
|
29
29
|
COMMONS_DENY_REASONS, commonsDenyReasonSchema, IDENTITY_APPROVAL_PUSH_CHANNEL, } from './commonsSignIn.js';
|
|
30
30
|
export { INBOX_EMAIL_PUSH_CHANNEL, INBOX_EMAIL_PUSH_TYPE, inboxEmailPushDataSchema, } from './inboxPush.js';
|
|
31
31
|
export { OXY_USER_INVALIDATION_CHANNEL, OXY_USER_CHANGE_REASONS, OXY_PUBLISHED_USER_CHANGE_REASONS, isPublishedOxyUserChangeReason, oxyUserInvalidationEventSchema, } from './userInvalidation.js';
|
|
32
|
+
export { OXY_SERVICE_EVENTS_NAMESPACE, OXY_SESSION_REVOKED_EVENT, OXY_SERVICE_EVENTS_HEARTBEAT_EVENT, OXY_SERVICE_EVENTS_HEARTBEAT_MS, OXY_SERVICE_EVENTS_STALE_AFTER_MS, OXY_SERVICE_EVENTS_FORBIDDEN, oxySessionRevocationEventSchema, oxyServiceEventsHeartbeatSchema, } from './sessionRevocation.js';
|
|
32
33
|
export {
|
|
33
34
|
// Schemas
|
|
34
35
|
recommendationExcludeTypeSchema, recommendationBoostSchema, recommendationSignalWeightsSchema, recommendationRequestSchema, recommendationCountSchema, recommendationItemSchema, recommendationResponseSchema, appEndorsementInputSchema, appInterestInputSchema, appUserSignalIngestSchema, appAffinityEventTypeSchema, appAffinityEventSchema, appAffinityEventsIngestSchema, } from './recommendations.js';
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Canonical contract for the session-revocation feed: oxy-api telling every
|
|
3
|
+
* connected Oxy backend that a session stopped being valid.
|
|
4
|
+
*
|
|
5
|
+
* WHY IT EXISTS. `@oxy.so/core/server` reuses a successful bearer validation on
|
|
6
|
+
* a backend for a short TTL, because an app backend cannot verify a user access
|
|
7
|
+
* token itself (HS256 under a secret only oxy-api holds) and asking Oxy on every
|
|
8
|
+
* request put ~300 ms on every authenticated route. A cache like that is only
|
|
9
|
+
* safe if it hears about revocations the moment they happen. This feed is how it
|
|
10
|
+
* hears: oxy-api announces every session it ends — logout, sign-out-all, device
|
|
11
|
+
* removal, an account switched away from, an admin or operator revocation, a
|
|
12
|
+
* credential change that ends sessions, account deletion or archive — and the
|
|
13
|
+
* SDK drops what it cached for that session or user.
|
|
14
|
+
*
|
|
15
|
+
* THE TRANSPORT IS THE SDK's. A backend opens no Redis client and wires nothing:
|
|
16
|
+
* `OxyServer` connects to the {@link OXY_SERVICE_EVENTS_NAMESPACE} Socket.IO
|
|
17
|
+
* namespace on oxy-api with its own service token, and uses its validation cache
|
|
18
|
+
* ONLY while that connection is live (connected, and a
|
|
19
|
+
* {@link OXY_SERVICE_EVENTS_HEARTBEAT_EVENT} seen within
|
|
20
|
+
* {@link OXY_SERVICE_EVENTS_STALE_AFTER_MS}). Disconnected, stale or never
|
|
21
|
+
* connected, it validates every request against Oxy. So a lost connection costs
|
|
22
|
+
* latency, never correctness.
|
|
23
|
+
*
|
|
24
|
+
* DELIVERY. A revocation is announced after the write that ended the session
|
|
25
|
+
* committed. Between oxy-api tasks it rides Valkey pub/sub, which is
|
|
26
|
+
* at-most-once; the heartbeat is what makes a silent loss of the path visible —
|
|
27
|
+
* a task emits it only while its own Valkey round trip works — so a consumer
|
|
28
|
+
* stops trusting its cache when the path stops working, instead of trusting it
|
|
29
|
+
* forever.
|
|
30
|
+
*
|
|
31
|
+
* PRIVACY — the payload carries ids and a timestamp only. Only Oxy's own
|
|
32
|
+
* (internal-tier) services may join the namespace, and even so nothing a
|
|
33
|
+
* consumer could render is ever placed on it.
|
|
34
|
+
*
|
|
35
|
+
* Platform-agnostic — zod only, no react/react-native/expo.
|
|
36
|
+
*/
|
|
37
|
+
import { z } from 'zod';
|
|
38
|
+
/** The Socket.IO namespace on oxy-api that carries service events. */
|
|
39
|
+
export const OXY_SERVICE_EVENTS_NAMESPACE = '/service-events';
|
|
40
|
+
/** One session (or every session of one user) stopped being valid. */
|
|
41
|
+
export const OXY_SESSION_REVOKED_EVENT = 'session:revoked';
|
|
42
|
+
/**
|
|
43
|
+
* Emitted on connect and then every {@link OXY_SERVICE_EVENTS_HEARTBEAT_MS}
|
|
44
|
+
* while the emitting oxy-api task can still hear revocations (its Valkey
|
|
45
|
+
* subscription round-trips). Carries `{ at }`, the task's epoch-ms clock.
|
|
46
|
+
*/
|
|
47
|
+
export const OXY_SERVICE_EVENTS_HEARTBEAT_EVENT = 'heartbeat';
|
|
48
|
+
/** How often a live oxy-api task sends {@link OXY_SERVICE_EVENTS_HEARTBEAT_EVENT}. */
|
|
49
|
+
export const OXY_SERVICE_EVENTS_HEARTBEAT_MS = 5000;
|
|
50
|
+
/**
|
|
51
|
+
* How long a consumer keeps trusting the feed after the last heartbeat. Past
|
|
52
|
+
* this the feed counts as down: every cached validation is dropped and nothing
|
|
53
|
+
* is cached until heartbeats resume.
|
|
54
|
+
*/
|
|
55
|
+
export const OXY_SERVICE_EVENTS_STALE_AFTER_MS = 12000;
|
|
56
|
+
/**
|
|
57
|
+
* The `connect_error` message oxy-api answers a caller that may never join the
|
|
58
|
+
* namespace (not a service token, or not an internal-tier application). A
|
|
59
|
+
* consumer stops retrying quickly on it; any other refusal is retried.
|
|
60
|
+
*/
|
|
61
|
+
export const OXY_SERVICE_EVENTS_FORBIDDEN = 'service_events_forbidden';
|
|
62
|
+
/**
|
|
63
|
+
* A session revocation.
|
|
64
|
+
*
|
|
65
|
+
* - With `sessionId`: that one session ended. `userId` is the account it spoke
|
|
66
|
+
* as.
|
|
67
|
+
* - Without `sessionId`: every session of `userId` ended, or may have — the
|
|
68
|
+
* account was deleted or archived, or signed out everywhere. A consumer drops
|
|
69
|
+
* everything it holds for that account, including sessions it operated as a
|
|
70
|
+
* delegate.
|
|
71
|
+
*
|
|
72
|
+
* `at` is the publisher's epoch-ms clock: diagnostic only (propagation delay),
|
|
73
|
+
* never used for ordering — the event says "ask Oxy again", which is idempotent.
|
|
74
|
+
*/
|
|
75
|
+
export const oxySessionRevocationEventSchema = z.object({
|
|
76
|
+
/** The session that ended; absent for a revocation of every session of `userId`. */
|
|
77
|
+
sessionId: z.string().min(1).max(256).optional(),
|
|
78
|
+
/** The account the session (or sessions) spoke as. */
|
|
79
|
+
userId: z.string().min(1).max(256),
|
|
80
|
+
/** Publisher's epoch-ms timestamp. Diagnostic only. */
|
|
81
|
+
at: z.number().int().nonnegative(),
|
|
82
|
+
});
|
|
83
|
+
/** The heartbeat payload. */
|
|
84
|
+
export const oxyServiceEventsHeartbeatSchema = z.object({
|
|
85
|
+
at: z.number().int().nonnegative(),
|
|
86
|
+
});
|
|
@@ -7,10 +7,10 @@
|
|
|
7
7
|
* {@link ACCOUNT_CATEGORY_IDS} for the four rules that govern it.
|
|
8
8
|
*/
|
|
9
9
|
import { z } from 'zod';
|
|
10
|
-
export { ACCOUNT_KINDS, CHILD_ACCOUNT_KINDS, isDelegatedActAsEligibleKind, isOperatorSwitchTargetKind, isAccountKind, ACCOUNT_CATEGORY_IDS, RETIRED_ACCOUNT_CATEGORY_IDS, isSelectableAccountCategoryId, SELECTABLE_ACCOUNT_CATEGORY_IDS, newlyAddedRetiredCategories, MAX_ACCOUNT_CATEGORIES, ACCOUNT_CATEGORY_KINDS, kindAcceptsAccountCategories, } from './client/accountGraph';
|
|
10
|
+
export { ACCOUNT_KINDS, CHILD_ACCOUNT_KINDS, isDelegatedActAsEligibleKind, isOperatorSwitchTargetKind, isMemberOperatedKind, isAccountKind, ACCOUNT_CATEGORY_IDS, RETIRED_ACCOUNT_CATEGORY_IDS, isSelectableAccountCategoryId, SELECTABLE_ACCOUNT_CATEGORY_IDS, newlyAddedRetiredCategories, MAX_ACCOUNT_CATEGORIES, ACCOUNT_CATEGORY_KINDS, kindAcceptsAccountCategories, } from './client/accountGraph';
|
|
11
11
|
export type { AccountKind, AccountKindGap, ChildAccountKind, ChildAccountKindGap, AccountCategoryId, AccountCategoryKind, } from './client/accountGraph';
|
|
12
12
|
export declare const accountKindSchema: z.ZodEnum<["personal", "organization", "project", "bot", "channel", "community"]>;
|
|
13
|
-
export declare const childAccountKindSchema: z.ZodEnum<["organization", "project", "bot", "channel"]>;
|
|
13
|
+
export declare const childAccountKindSchema: z.ZodEnum<["organization", "project", "bot", "channel", "community"]>;
|
|
14
14
|
/**
|
|
15
15
|
* Accepts EVERY id, withdrawn ones included — see rule 3.
|
|
16
16
|
*
|
|
@@ -71,7 +71,7 @@ export declare const accountNameSchema: z.ZodOptional<z.ZodObject<{
|
|
|
71
71
|
*/
|
|
72
72
|
export declare const createAccountRequestSchema: z.ZodEffects<z.ZodObject<{
|
|
73
73
|
parentAccountId: z.ZodOptional<z.ZodString>;
|
|
74
|
-
kind: z.ZodEnum<["organization", "project", "bot", "channel"]>;
|
|
74
|
+
kind: z.ZodEnum<["organization", "project", "bot", "channel", "community"]>;
|
|
75
75
|
/**
|
|
76
76
|
* The SAME policy a person's handle is held to. `users.username` is one unique
|
|
77
77
|
* index, so a managed account may not reserve a name a person could not ask
|
|
@@ -169,7 +169,7 @@ export declare const createAccountRequestSchema: z.ZodEffects<z.ZodObject<{
|
|
|
169
169
|
*/
|
|
170
170
|
character: z.ZodOptional<z.ZodType<import("./avatarCharacter").AvatarCharacter, z.ZodTypeDef, unknown>>;
|
|
171
171
|
}, "strip", z.ZodTypeAny, {
|
|
172
|
-
kind: "organization" | "project" | "bot" | "channel";
|
|
172
|
+
kind: "organization" | "project" | "bot" | "channel" | "community";
|
|
173
173
|
username: string;
|
|
174
174
|
color?: string | undefined;
|
|
175
175
|
name?: {
|
|
@@ -186,7 +186,7 @@ export declare const createAccountRequestSchema: z.ZodEffects<z.ZodObject<{
|
|
|
186
186
|
isPrivateAccount?: boolean | undefined;
|
|
187
187
|
character?: import("./avatarCharacter").AvatarCharacter | undefined;
|
|
188
188
|
}, {
|
|
189
|
-
kind: "organization" | "project" | "bot" | "channel";
|
|
189
|
+
kind: "organization" | "project" | "bot" | "channel" | "community";
|
|
190
190
|
username: string;
|
|
191
191
|
color?: string | undefined;
|
|
192
192
|
name?: {
|
|
@@ -203,7 +203,7 @@ export declare const createAccountRequestSchema: z.ZodEffects<z.ZodObject<{
|
|
|
203
203
|
isPrivateAccount?: boolean | undefined;
|
|
204
204
|
character?: unknown;
|
|
205
205
|
}>, {
|
|
206
|
-
kind: "organization" | "project" | "bot" | "channel";
|
|
206
|
+
kind: "organization" | "project" | "bot" | "channel" | "community";
|
|
207
207
|
username: string;
|
|
208
208
|
color?: string | undefined;
|
|
209
209
|
name?: {
|
|
@@ -220,7 +220,7 @@ export declare const createAccountRequestSchema: z.ZodEffects<z.ZodObject<{
|
|
|
220
220
|
isPrivateAccount?: boolean | undefined;
|
|
221
221
|
character?: import("./avatarCharacter").AvatarCharacter | undefined;
|
|
222
222
|
}, {
|
|
223
|
-
kind: "organization" | "project" | "bot" | "channel";
|
|
223
|
+
kind: "organization" | "project" | "bot" | "channel" | "community";
|
|
224
224
|
username: string;
|
|
225
225
|
color?: string | undefined;
|
|
226
226
|
name?: {
|
|
@@ -37,16 +37,16 @@ export declare const ACCOUNT_KINDS: readonly ["personal", "organization", "proje
|
|
|
37
37
|
export type AccountKindGap = Exclude<AccountKind, (typeof ACCOUNT_KINDS)[number]>;
|
|
38
38
|
/**
|
|
39
39
|
* Kinds that may be CREATED as children of another account: `ACCOUNT_KINDS`
|
|
40
|
-
* minus `personal`, which is always a tree root
|
|
40
|
+
* minus `personal`, which is always a tree root.
|
|
41
41
|
*
|
|
42
42
|
* A `community` is a forum its members post INTO and that re-broadcasts what
|
|
43
|
-
* they post (an ActivityPub `Group`: a Lemmy or Mbin community).
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
43
|
+
* they post (an ActivityPub `Group`: a Lemmy or Mbin community, FEP-1b12). Its
|
|
44
|
+
* members are its moderators, and it is never acted as. Oxy holds the account;
|
|
45
|
+
* the app it lives in (Mention) is what forwards a member's post to the
|
|
46
|
+
* community's followers, so creating one is creating that promise.
|
|
47
47
|
*/
|
|
48
|
-
export type ChildAccountKind = Exclude<AccountKind, 'personal'
|
|
49
|
-
export declare const CHILD_ACCOUNT_KINDS: readonly ["organization", "project", "bot", "channel"];
|
|
48
|
+
export type ChildAccountKind = Exclude<AccountKind, 'personal'>;
|
|
49
|
+
export declare const CHILD_ACCOUNT_KINDS: readonly ["organization", "project", "bot", "channel", "community"];
|
|
50
50
|
/** `never` while `CHILD_ACCOUNT_KINDS` covers the child union. */
|
|
51
51
|
export type ChildAccountKindGap = Exclude<ChildAccountKind, (typeof CHILD_ACCOUNT_KINDS)[number]>;
|
|
52
52
|
/**
|
|
@@ -114,6 +114,14 @@ export declare function isDelegatedActAsEligibleKind(kind: AccountKind | null |
|
|
|
114
114
|
* hands out a seat.
|
|
115
115
|
*/
|
|
116
116
|
export declare function isOperatorSwitchTargetKind(kind: AccountKind | null | undefined): boolean;
|
|
117
|
+
/**
|
|
118
|
+
* Whether an account of this kind is OPERATED BY ITS MEMBERS rather than acted
|
|
119
|
+
* as: a `channel` (its members write as it) or a `community` (its members are
|
|
120
|
+
* its moderators). Neither can be the subject of a session or a delegation
|
|
121
|
+
* ({@link isDelegatedActAsEligibleKind} refuses both), so there is no right
|
|
122
|
+
* stronger than active membership to ask for, and membership is the whole of it.
|
|
123
|
+
*/
|
|
124
|
+
export declare function isMemberOperatedKind(kind: AccountKind | null | undefined): boolean;
|
|
117
125
|
/**
|
|
118
126
|
* Narrow an unknown value to an {@link AccountKind}.
|
|
119
127
|
*
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
* here; import them from `@oxy.so/contracts` with `import type`.
|
|
16
16
|
*/
|
|
17
17
|
export { type Check, type CheckIssue, type CheckPath, type CheckResult, ContractCheckError, checkContract, formatCheckPath, parseContract, } from './check';
|
|
18
|
-
export { ACCOUNT_CATEGORY_IDS, ACCOUNT_CATEGORY_KINDS, ACCOUNT_KINDS, CHILD_ACCOUNT_KINDS, MAX_ACCOUNT_CATEGORIES, RETIRED_ACCOUNT_CATEGORY_IDS, SELECTABLE_ACCOUNT_CATEGORY_IDS, isAccountKind, isDelegatedActAsEligibleKind, isOperatorSwitchTargetKind, isSelectableAccountCategoryId, kindAcceptsAccountCategories, newlyAddedRetiredCategories, } from './accountGraph';
|
|
18
|
+
export { ACCOUNT_CATEGORY_IDS, ACCOUNT_CATEGORY_KINDS, ACCOUNT_KINDS, CHILD_ACCOUNT_KINDS, MAX_ACCOUNT_CATEGORIES, RETIRED_ACCOUNT_CATEGORY_IDS, SELECTABLE_ACCOUNT_CATEGORY_IDS, isAccountKind, isDelegatedActAsEligibleKind, isMemberOperatedKind, isOperatorSwitchTargetKind, isSelectableAccountCategoryId, kindAcceptsAccountCategories, newlyAddedRetiredCategories, } from './accountGraph';
|
|
19
19
|
export { ACCOUNT_NAME_POLICY_BY_KIND, ACCOUNT_TITLE_DISALLOWED_SOURCE, ACCOUNT_TITLE_MAX_LENGTH, accountNamePolicyForKind, accountTitleCheck, isPlainTextTitle, } from './accountName';
|
|
20
20
|
export { EMAIL_CODE_LENGTH, EMAIL_CODE_MAX_ATTEMPTS, EMAIL_CODE_TTL_MS, EMAIL_TICKET_TTL_MS, EMAIL_VERIFICATION_ERROR_CODES, EMAIL_VERIFICATION_PURPOSES, emailAddressCheck, emailTicketCheck, emailVerificationConfirmResponseCheck, emailVerificationStartResponseCheck, } from './accountEmail';
|
|
21
21
|
export { ACCOUNT_AUTH_METHODS, AGENT_PROOF_ACTIONS, AGENT_PROOF_AUDIENCE, AGENT_PROOF_TTL_MS, agentChallengeRequestCheck, agentKeyListResponseCheck, agentKeyOperationChallengeCheck, agentKeyOperationCheck, agentKeyOperationResultCheck, agentProofClaimsCheck, agentVerifyRequestCheck, executeAgentKeyOperationCheck, } from './agentKeys';
|
package/dist/types/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* Platform-agnostic — zod is the only runtime dependency. No react/react-native/
|
|
10
10
|
* expo, no `require()` in the ESM build.
|
|
11
11
|
*/
|
|
12
|
-
export { ACCOUNT_KINDS, accountKindSchema, CHILD_ACCOUNT_KINDS, childAccountKindSchema, isAccountKind, isDelegatedActAsEligibleKind, isOperatorSwitchTargetKind, ACCOUNT_CATEGORY_IDS, ACCOUNT_CATEGORY_KINDS, accountCategoriesSchema, accountCategoryIdSchema, isSelectableAccountCategoryId, kindAcceptsAccountCategories, MAX_ACCOUNT_CATEGORIES, newlyAddedRetiredCategories, RETIRED_ACCOUNT_CATEGORY_IDS, SELECTABLE_ACCOUNT_CATEGORY_IDS, createAccountRequestSchema, accountNameSchema, } from './accountGraph';
|
|
12
|
+
export { ACCOUNT_KINDS, accountKindSchema, CHILD_ACCOUNT_KINDS, childAccountKindSchema, isAccountKind, isDelegatedActAsEligibleKind, isOperatorSwitchTargetKind, isMemberOperatedKind, ACCOUNT_CATEGORY_IDS, ACCOUNT_CATEGORY_KINDS, accountCategoriesSchema, accountCategoryIdSchema, isSelectableAccountCategoryId, kindAcceptsAccountCategories, MAX_ACCOUNT_CATEGORIES, newlyAddedRetiredCategories, RETIRED_ACCOUNT_CATEGORY_IDS, SELECTABLE_ACCOUNT_CATEGORY_IDS, createAccountRequestSchema, accountNameSchema, } from './accountGraph';
|
|
13
13
|
export type { AccountKind, AccountCategoryId, AccountCategoryKind, ChildAccountKind, CreateAccountRequest, } from './accountGraph';
|
|
14
14
|
export { ACCOUNT_NAME_POLICY_BY_KIND, ACCOUNT_TITLE_DISALLOWED_SOURCE, ACCOUNT_TITLE_MAX_LENGTH, accountNamePolicyForKind, accountTitleSchema, isPlainTextTitle, } from './accountName';
|
|
15
15
|
export type { AccountNamePolicy } from './accountName';
|
|
@@ -28,6 +28,8 @@ export { INBOX_EMAIL_PUSH_CHANNEL, INBOX_EMAIL_PUSH_TYPE, inboxEmailPushDataSche
|
|
|
28
28
|
export type { InboxEmailPushData } from './inboxPush';
|
|
29
29
|
export { OXY_USER_INVALIDATION_CHANNEL, OXY_USER_CHANGE_REASONS, OXY_PUBLISHED_USER_CHANGE_REASONS, isPublishedOxyUserChangeReason, oxyUserInvalidationEventSchema, } from './userInvalidation';
|
|
30
30
|
export type { OxyUserChangeReason, PublishedOxyUserChangeReason, OxyUserInvalidationEvent, } from './userInvalidation';
|
|
31
|
+
export { OXY_SERVICE_EVENTS_NAMESPACE, OXY_SESSION_REVOKED_EVENT, OXY_SERVICE_EVENTS_HEARTBEAT_EVENT, OXY_SERVICE_EVENTS_HEARTBEAT_MS, OXY_SERVICE_EVENTS_STALE_AFTER_MS, OXY_SERVICE_EVENTS_FORBIDDEN, oxySessionRevocationEventSchema, oxyServiceEventsHeartbeatSchema, } from './sessionRevocation';
|
|
32
|
+
export type { OxySessionRevocationEvent, OxyServiceEventsHeartbeat } from './sessionRevocation';
|
|
31
33
|
export { recommendationExcludeTypeSchema, recommendationBoostSchema, recommendationSignalWeightsSchema, recommendationRequestSchema, recommendationCountSchema, recommendationItemSchema, recommendationResponseSchema, appEndorsementInputSchema, appInterestInputSchema, appUserSignalIngestSchema, appAffinityEventTypeSchema, appAffinityEventSchema, appAffinityEventsIngestSchema, } from './recommendations';
|
|
32
34
|
export type { RecommendationExcludeType, RecommendationBoost, RecommendationSignalWeights, RecommendationRequest, RecommendationCount, RecommendationItem, RecommendationResponse, AppEndorsementInput, AppInterestInput, AppUserSignalIngest, AppAffinityEventType, AppAffinityEvent, AppAffinityEventsIngest, } from './recommendations';
|
|
33
35
|
export { verificationMethodSchema, didServiceSchema, didDocumentSchema, signedRecordEnvelopeSchema, verifiedDomainSchema, domainVerificationRequestSchema, resourceDomainOwnershipRequestSchema, resourceDomainOwnershipResponseSchema, domainVerificationInstructionsSchema, authMethodEntrySchema, authMethodsResponseSchema, exportAttestationSchema, exportUsageReceiptSchema, exportLedgerEntrySchema, exportUsageReservationSchema, exportFinancialSectionSchema, exportBundleSchema, } from './identity';
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Canonical contract for the session-revocation feed: oxy-api telling every
|
|
3
|
+
* connected Oxy backend that a session stopped being valid.
|
|
4
|
+
*
|
|
5
|
+
* WHY IT EXISTS. `@oxy.so/core/server` reuses a successful bearer validation on
|
|
6
|
+
* a backend for a short TTL, because an app backend cannot verify a user access
|
|
7
|
+
* token itself (HS256 under a secret only oxy-api holds) and asking Oxy on every
|
|
8
|
+
* request put ~300 ms on every authenticated route. A cache like that is only
|
|
9
|
+
* safe if it hears about revocations the moment they happen. This feed is how it
|
|
10
|
+
* hears: oxy-api announces every session it ends — logout, sign-out-all, device
|
|
11
|
+
* removal, an account switched away from, an admin or operator revocation, a
|
|
12
|
+
* credential change that ends sessions, account deletion or archive — and the
|
|
13
|
+
* SDK drops what it cached for that session or user.
|
|
14
|
+
*
|
|
15
|
+
* THE TRANSPORT IS THE SDK's. A backend opens no Redis client and wires nothing:
|
|
16
|
+
* `OxyServer` connects to the {@link OXY_SERVICE_EVENTS_NAMESPACE} Socket.IO
|
|
17
|
+
* namespace on oxy-api with its own service token, and uses its validation cache
|
|
18
|
+
* ONLY while that connection is live (connected, and a
|
|
19
|
+
* {@link OXY_SERVICE_EVENTS_HEARTBEAT_EVENT} seen within
|
|
20
|
+
* {@link OXY_SERVICE_EVENTS_STALE_AFTER_MS}). Disconnected, stale or never
|
|
21
|
+
* connected, it validates every request against Oxy. So a lost connection costs
|
|
22
|
+
* latency, never correctness.
|
|
23
|
+
*
|
|
24
|
+
* DELIVERY. A revocation is announced after the write that ended the session
|
|
25
|
+
* committed. Between oxy-api tasks it rides Valkey pub/sub, which is
|
|
26
|
+
* at-most-once; the heartbeat is what makes a silent loss of the path visible —
|
|
27
|
+
* a task emits it only while its own Valkey round trip works — so a consumer
|
|
28
|
+
* stops trusting its cache when the path stops working, instead of trusting it
|
|
29
|
+
* forever.
|
|
30
|
+
*
|
|
31
|
+
* PRIVACY — the payload carries ids and a timestamp only. Only Oxy's own
|
|
32
|
+
* (internal-tier) services may join the namespace, and even so nothing a
|
|
33
|
+
* consumer could render is ever placed on it.
|
|
34
|
+
*
|
|
35
|
+
* Platform-agnostic — zod only, no react/react-native/expo.
|
|
36
|
+
*/
|
|
37
|
+
import { z } from 'zod';
|
|
38
|
+
/** The Socket.IO namespace on oxy-api that carries service events. */
|
|
39
|
+
export declare const OXY_SERVICE_EVENTS_NAMESPACE = "/service-events";
|
|
40
|
+
/** One session (or every session of one user) stopped being valid. */
|
|
41
|
+
export declare const OXY_SESSION_REVOKED_EVENT = "session:revoked";
|
|
42
|
+
/**
|
|
43
|
+
* Emitted on connect and then every {@link OXY_SERVICE_EVENTS_HEARTBEAT_MS}
|
|
44
|
+
* while the emitting oxy-api task can still hear revocations (its Valkey
|
|
45
|
+
* subscription round-trips). Carries `{ at }`, the task's epoch-ms clock.
|
|
46
|
+
*/
|
|
47
|
+
export declare const OXY_SERVICE_EVENTS_HEARTBEAT_EVENT = "heartbeat";
|
|
48
|
+
/** How often a live oxy-api task sends {@link OXY_SERVICE_EVENTS_HEARTBEAT_EVENT}. */
|
|
49
|
+
export declare const OXY_SERVICE_EVENTS_HEARTBEAT_MS = 5000;
|
|
50
|
+
/**
|
|
51
|
+
* How long a consumer keeps trusting the feed after the last heartbeat. Past
|
|
52
|
+
* this the feed counts as down: every cached validation is dropped and nothing
|
|
53
|
+
* is cached until heartbeats resume.
|
|
54
|
+
*/
|
|
55
|
+
export declare const OXY_SERVICE_EVENTS_STALE_AFTER_MS = 12000;
|
|
56
|
+
/**
|
|
57
|
+
* The `connect_error` message oxy-api answers a caller that may never join the
|
|
58
|
+
* namespace (not a service token, or not an internal-tier application). A
|
|
59
|
+
* consumer stops retrying quickly on it; any other refusal is retried.
|
|
60
|
+
*/
|
|
61
|
+
export declare const OXY_SERVICE_EVENTS_FORBIDDEN = "service_events_forbidden";
|
|
62
|
+
/**
|
|
63
|
+
* A session revocation.
|
|
64
|
+
*
|
|
65
|
+
* - With `sessionId`: that one session ended. `userId` is the account it spoke
|
|
66
|
+
* as.
|
|
67
|
+
* - Without `sessionId`: every session of `userId` ended, or may have — the
|
|
68
|
+
* account was deleted or archived, or signed out everywhere. A consumer drops
|
|
69
|
+
* everything it holds for that account, including sessions it operated as a
|
|
70
|
+
* delegate.
|
|
71
|
+
*
|
|
72
|
+
* `at` is the publisher's epoch-ms clock: diagnostic only (propagation delay),
|
|
73
|
+
* never used for ordering — the event says "ask Oxy again", which is idempotent.
|
|
74
|
+
*/
|
|
75
|
+
export declare const oxySessionRevocationEventSchema: z.ZodObject<{
|
|
76
|
+
/** The session that ended; absent for a revocation of every session of `userId`. */
|
|
77
|
+
sessionId: z.ZodOptional<z.ZodString>;
|
|
78
|
+
/** The account the session (or sessions) spoke as. */
|
|
79
|
+
userId: z.ZodString;
|
|
80
|
+
/** Publisher's epoch-ms timestamp. Diagnostic only. */
|
|
81
|
+
at: z.ZodNumber;
|
|
82
|
+
}, "strip", z.ZodTypeAny, {
|
|
83
|
+
at: number;
|
|
84
|
+
userId: string;
|
|
85
|
+
sessionId?: string | undefined;
|
|
86
|
+
}, {
|
|
87
|
+
at: number;
|
|
88
|
+
userId: string;
|
|
89
|
+
sessionId?: string | undefined;
|
|
90
|
+
}>;
|
|
91
|
+
export type OxySessionRevocationEvent = z.infer<typeof oxySessionRevocationEventSchema>;
|
|
92
|
+
/** The heartbeat payload. */
|
|
93
|
+
export declare const oxyServiceEventsHeartbeatSchema: z.ZodObject<{
|
|
94
|
+
at: z.ZodNumber;
|
|
95
|
+
}, "strip", z.ZodTypeAny, {
|
|
96
|
+
at: number;
|
|
97
|
+
}, {
|
|
98
|
+
at: number;
|
|
99
|
+
}>;
|
|
100
|
+
export type OxyServiceEventsHeartbeat = z.infer<typeof oxyServiceEventsHeartbeatSchema>;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@oxy.so/contracts",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.5.0",
|
|
4
4
|
"description": "OxyHQ API contracts — single source of truth for request/response Zod schemas and inferred types, shared by the backend and the client SDKs",
|
|
5
5
|
"main": "dist/cjs/index.js",
|
|
6
6
|
"module": "dist/esm/index.js",
|