From 8d1f2b11c6ee6c92133961032b29bd083d65942f Mon Sep 17 00:00:00 2001 From: Cesare Naldi Date: Thu, 14 Sep 2023 23:58:02 +0200 Subject: [PATCH 1/3] feat: adds docs --- .changeset/swift-days-wash.md | 5 + README.md | 163 +- docs/.nojekyll | 1 + docs/assets/highlight.css | 99 ++ docs/assets/main.js | 59 + docs/assets/navigation.js | 1 + docs/assets/search.js | 1 + docs/assets/style.css | 1383 +++++++++++++++++ docs/classes/ValidationError.html | 119 ++ docs/enums/ConditionComparisonOperator.html | 113 ++ docs/enums/ConditionType.html | 127 ++ docs/enums/EncryptionProvider.html | 78 + ...rketplaceMetadataAttributeDisplayType.html | 92 ++ docs/enums/MediaAudioKind.html | 113 ++ docs/enums/MediaAudioMimeType.html | 127 ++ docs/enums/MediaImageMimeType.html | 127 ++ docs/enums/MediaVideoMimeType.html | 141 ++ docs/enums/MetadataAttributeType.html | 106 ++ docs/enums/MetadataLicenseType.html | 323 ++++ docs/enums/MirrorSchemaId.html | 78 + docs/enums/NftContractType.html | 85 + docs/enums/ProfileSchemaId.html | 78 + docs/enums/PublicationContentWarning.html | 92 ++ docs/enums/PublicationMainFocus.html | 183 +++ docs/enums/PublicationSchemaId.html | 176 +++ docs/enums/ThreeDFormat.html | 99 ++ docs/enums/TransactionMetadataType.html | 92 ++ docs/functions/andCondition-1.html | 72 + docs/functions/article.html | 139 ++ docs/functions/asset-2.html | 77 + docs/functions/audio.html | 166 ++ docs/functions/checkingIn.html | 156 ++ docs/functions/embed.html | 139 ++ docs/functions/event.html | 169 ++ docs/functions/extractVersion.html | 67 + docs/functions/followCondition-1.html | 72 + docs/functions/formatZodError.html | 67 + docs/functions/geoPoint-1.html | 70 + docs/functions/geoUri-1.html | 75 + docs/functions/image-16.html | 152 ++ docs/functions/link.html | 139 ++ docs/functions/livestream.html | 149 ++ docs/functions/mint.html | 139 ++ docs/functions/mirror.html | 88 ++ docs/functions/nftOwnershipCondition-1.html | 67 + docs/functions/orCondition-1.html | 72 + docs/functions/profile.html | 94 ++ .../profileOwnershipCondition-1.html | 72 + docs/functions/space.html | 143 ++ docs/functions/story.html | 137 ++ docs/functions/textOnly.html | 135 ++ docs/functions/threeD.html | 139 ++ docs/functions/transaction.html | 143 ++ docs/functions/video.html | 156 ++ docs/index.html | 309 ++++ docs/modules.html | 214 +++ docs/types/AccessCondition.html | 58 + docs/types/Address.html | 76 + docs/types/Amount.html | 68 + docs/types/AndCondition.html | 70 + docs/types/AnyMedia.html | 115 ++ docs/types/AppId.html | 61 + docs/types/ArticleMetadata.html | 79 + docs/types/ArticleOptions.html | 59 + docs/types/Asset-1.html | 68 + docs/types/AudioMetadata.html | 79 + docs/types/AudioOptions.html | 59 + docs/types/BooleanAttribute.html | 67 + docs/types/ChainId.html | 61 + docs/types/CheckingInMetadata.html | 79 + docs/types/CheckingInOptions.html | 59 + docs/types/CollectCondition.html | 67 + docs/types/DateAttribute.html | 67 + docs/types/Datetime.html | 61 + docs/types/EmbedMetadata.html | 79 + docs/types/EmbedOptions.html | 59 + docs/types/EncryptedPaths.html | 59 + docs/types/EncryptedString.html | 61 + docs/types/EoaOwnershipCondition.html | 65 + docs/types/Erc20OwnershipCondition.html | 67 + docs/types/EventMetadata.html | 79 + docs/types/EventOptions.html | 59 + docs/types/EvmAddress.html | 61 + docs/types/FollowCondition.html | 65 + docs/types/GeoPoint.html | 68 + docs/types/GeoURI.html | 64 + docs/types/ImageMetadata.html | 79 + docs/types/ImageOptions.html | 59 + docs/types/JSONAttribute.html | 67 + docs/types/LinkMetadata.html | 79 + docs/types/LinkOptions.html | 59 + docs/types/LitEncryptionKey.html | 61 + docs/types/LitEncryptionStrategy.html | 69 + docs/types/LivestreamMetadata.html | 79 + docs/types/LivestreamOptions.html | 59 + docs/types/Locale.html | 70 + docs/types/Markdown.html | 61 + docs/types/MarketplaceMetadata.html | 73 + docs/types/MarketplaceMetadataAttribute.html | 67 + docs/types/MediaAudio.html | 85 + docs/types/MediaImage.html | 71 + docs/types/MediaVideo.html | 75 + docs/types/MetadataAttribute.html | 103 ++ docs/types/MintMetadata.html | 79 + docs/types/MintOptions.html | 59 + docs/types/MirrorMetadata.html | 65 + docs/types/MirrorOptions.html | 59 + docs/types/NetworkAddress.html | 68 + docs/types/NftOwnershipCondition.html | 69 + docs/types/NumberAttribute.html | 67 + docs/types/OrCondition.html | 70 + docs/types/ProfileId.html | 61 + docs/types/ProfileMetadata.html | 67 + docs/types/ProfileMetadataDetails.html | 75 + docs/types/ProfileOptions.html | 59 + docs/types/ProfileOwnershipCondition.html | 65 + docs/types/PublicationEncryptionStrategy.html | 73 + docs/types/PublicationId-1.html | 61 + docs/types/PublicationMetadata.html | 376 +++++ docs/types/SchedulingAdjustments.html | 65 + docs/types/Signature-10.html | 61 + docs/types/SimpleCondition.html | 58 + docs/types/SpaceMetadata.html | 79 + docs/types/SpaceOptions.html | 59 + docs/types/StoryMetadata.html | 79 + docs/types/StoryOptions.html | 59 + docs/types/StringAttribute.html | 67 + docs/types/Tag.html | 61 + docs/types/TextOnlyMetadata.html | 79 + docs/types/TextOnlyOptions.html | 59 + docs/types/ThreeDAsset.html | 71 + docs/types/ThreeDMetadata.html | 79 + docs/types/ThreeDOptions.html | 59 + docs/types/TimezoneId-1.html | 58 + docs/types/TokenId.html | 61 + docs/types/TransactionMetadata.html | 79 + docs/types/TransactionOptions.html | 59 + docs/types/TwoAtLeastArray.html | 66 + docs/types/URI-1.html | 63 + docs/types/VideoMetadata.html | 79 + docs/types/VideoOptions.html | 59 + docs/variables/AnyMediaSchema.html | 58 + docs/variables/BooleanAttributeSchema.html | 58 + docs/variables/DateAttributeSchema.html | 58 + docs/variables/JSONAttributeSchema.html | 58 + .../MarketplaceMetadataAttributeSchema.html | 58 + docs/variables/MarketplaceMetadataSchema.html | 58 + docs/variables/MediaAudioSchema.html | 58 + docs/variables/MediaImageSchema.html | 58 + docs/variables/MediaVideoSchema.html | 58 + docs/variables/MetadataAttributeSchema.html | 58 + docs/variables/MetadataLicenseTypeSchema.html | 58 + docs/variables/MirrorMetadataSchema.html | 69 + docs/variables/NumberAttributeSchema.html | 58 + docs/variables/ProfileMetadataSchema.html | 69 + docs/variables/PublicationMetadataSchema.html | 69 + docs/variables/StringAttributeSchema.html | 58 + docs/variables/ThreeDSchema.html | 58 + docs/variables/TimezoneIdSchema.html | 58 + docs/variables/timezones.html | 58 + package.json | 6 +- pnpm-lock.yaml | 63 + src/builders.ts | 132 +- src/index.ts | 2 +- src/legacy/profile.ts | 2 + src/primitives.ts | 15 +- src/profile/ProfileMetadataSchema.ts | 2 + src/publication/MirrorSchema.ts | 2 + src/publication/common/encryption.ts | 10 +- src/publication/index.ts | 2 + tsdoc.json | 4 + typedoc.json | 20 + 172 files changed, 15063 insertions(+), 97 deletions(-) create mode 100644 .changeset/swift-days-wash.md create mode 100644 docs/.nojekyll create mode 100644 docs/assets/highlight.css create mode 100644 docs/assets/main.js create mode 100644 docs/assets/navigation.js create mode 100644 docs/assets/search.js create mode 100644 docs/assets/style.css create mode 100644 docs/classes/ValidationError.html create mode 100644 docs/enums/ConditionComparisonOperator.html create mode 100644 docs/enums/ConditionType.html create mode 100644 docs/enums/EncryptionProvider.html create mode 100644 docs/enums/MarketplaceMetadataAttributeDisplayType.html create mode 100644 docs/enums/MediaAudioKind.html create mode 100644 docs/enums/MediaAudioMimeType.html create mode 100644 docs/enums/MediaImageMimeType.html create mode 100644 docs/enums/MediaVideoMimeType.html create mode 100644 docs/enums/MetadataAttributeType.html create mode 100644 docs/enums/MetadataLicenseType.html create mode 100644 docs/enums/MirrorSchemaId.html create mode 100644 docs/enums/NftContractType.html create mode 100644 docs/enums/ProfileSchemaId.html create mode 100644 docs/enums/PublicationContentWarning.html create mode 100644 docs/enums/PublicationMainFocus.html create mode 100644 docs/enums/PublicationSchemaId.html create mode 100644 docs/enums/ThreeDFormat.html create mode 100644 docs/enums/TransactionMetadataType.html create mode 100644 docs/functions/andCondition-1.html create mode 100644 docs/functions/article.html create mode 100644 docs/functions/asset-2.html create mode 100644 docs/functions/audio.html create mode 100644 docs/functions/checkingIn.html create mode 100644 docs/functions/embed.html create mode 100644 docs/functions/event.html create mode 100644 docs/functions/extractVersion.html create mode 100644 docs/functions/followCondition-1.html create mode 100644 docs/functions/formatZodError.html create mode 100644 docs/functions/geoPoint-1.html create mode 100644 docs/functions/geoUri-1.html create mode 100644 docs/functions/image-16.html create mode 100644 docs/functions/link.html create mode 100644 docs/functions/livestream.html create mode 100644 docs/functions/mint.html create mode 100644 docs/functions/mirror.html create mode 100644 docs/functions/nftOwnershipCondition-1.html create mode 100644 docs/functions/orCondition-1.html create mode 100644 docs/functions/profile.html create mode 100644 docs/functions/profileOwnershipCondition-1.html create mode 100644 docs/functions/space.html create mode 100644 docs/functions/story.html create mode 100644 docs/functions/textOnly.html create mode 100644 docs/functions/threeD.html create mode 100644 docs/functions/transaction.html create mode 100644 docs/functions/video.html create mode 100644 docs/index.html create mode 100644 docs/modules.html create mode 100644 docs/types/AccessCondition.html create mode 100644 docs/types/Address.html create mode 100644 docs/types/Amount.html create mode 100644 docs/types/AndCondition.html create mode 100644 docs/types/AnyMedia.html create mode 100644 docs/types/AppId.html create mode 100644 docs/types/ArticleMetadata.html create mode 100644 docs/types/ArticleOptions.html create mode 100644 docs/types/Asset-1.html create mode 100644 docs/types/AudioMetadata.html create mode 100644 docs/types/AudioOptions.html create mode 100644 docs/types/BooleanAttribute.html create mode 100644 docs/types/ChainId.html create mode 100644 docs/types/CheckingInMetadata.html create mode 100644 docs/types/CheckingInOptions.html create mode 100644 docs/types/CollectCondition.html create mode 100644 docs/types/DateAttribute.html create mode 100644 docs/types/Datetime.html create mode 100644 docs/types/EmbedMetadata.html create mode 100644 docs/types/EmbedOptions.html create mode 100644 docs/types/EncryptedPaths.html create mode 100644 docs/types/EncryptedString.html create mode 100644 docs/types/EoaOwnershipCondition.html create mode 100644 docs/types/Erc20OwnershipCondition.html create mode 100644 docs/types/EventMetadata.html create mode 100644 docs/types/EventOptions.html create mode 100644 docs/types/EvmAddress.html create mode 100644 docs/types/FollowCondition.html create mode 100644 docs/types/GeoPoint.html create mode 100644 docs/types/GeoURI.html create mode 100644 docs/types/ImageMetadata.html create mode 100644 docs/types/ImageOptions.html create mode 100644 docs/types/JSONAttribute.html create mode 100644 docs/types/LinkMetadata.html create mode 100644 docs/types/LinkOptions.html create mode 100644 docs/types/LitEncryptionKey.html create mode 100644 docs/types/LitEncryptionStrategy.html create mode 100644 docs/types/LivestreamMetadata.html create mode 100644 docs/types/LivestreamOptions.html create mode 100644 docs/types/Locale.html create mode 100644 docs/types/Markdown.html create mode 100644 docs/types/MarketplaceMetadata.html create mode 100644 docs/types/MarketplaceMetadataAttribute.html create mode 100644 docs/types/MediaAudio.html create mode 100644 docs/types/MediaImage.html create mode 100644 docs/types/MediaVideo.html create mode 100644 docs/types/MetadataAttribute.html create mode 100644 docs/types/MintMetadata.html create mode 100644 docs/types/MintOptions.html create mode 100644 docs/types/MirrorMetadata.html create mode 100644 docs/types/MirrorOptions.html create mode 100644 docs/types/NetworkAddress.html create mode 100644 docs/types/NftOwnershipCondition.html create mode 100644 docs/types/NumberAttribute.html create mode 100644 docs/types/OrCondition.html create mode 100644 docs/types/ProfileId.html create mode 100644 docs/types/ProfileMetadata.html create mode 100644 docs/types/ProfileMetadataDetails.html create mode 100644 docs/types/ProfileOptions.html create mode 100644 docs/types/ProfileOwnershipCondition.html create mode 100644 docs/types/PublicationEncryptionStrategy.html create mode 100644 docs/types/PublicationId-1.html create mode 100644 docs/types/PublicationMetadata.html create mode 100644 docs/types/SchedulingAdjustments.html create mode 100644 docs/types/Signature-10.html create mode 100644 docs/types/SimpleCondition.html create mode 100644 docs/types/SpaceMetadata.html create mode 100644 docs/types/SpaceOptions.html create mode 100644 docs/types/StoryMetadata.html create mode 100644 docs/types/StoryOptions.html create mode 100644 docs/types/StringAttribute.html create mode 100644 docs/types/Tag.html create mode 100644 docs/types/TextOnlyMetadata.html create mode 100644 docs/types/TextOnlyOptions.html create mode 100644 docs/types/ThreeDAsset.html create mode 100644 docs/types/ThreeDMetadata.html create mode 100644 docs/types/ThreeDOptions.html create mode 100644 docs/types/TimezoneId-1.html create mode 100644 docs/types/TokenId.html create mode 100644 docs/types/TransactionMetadata.html create mode 100644 docs/types/TransactionOptions.html create mode 100644 docs/types/TwoAtLeastArray.html create mode 100644 docs/types/URI-1.html create mode 100644 docs/types/VideoMetadata.html create mode 100644 docs/types/VideoOptions.html create mode 100644 docs/variables/AnyMediaSchema.html create mode 100644 docs/variables/BooleanAttributeSchema.html create mode 100644 docs/variables/DateAttributeSchema.html create mode 100644 docs/variables/JSONAttributeSchema.html create mode 100644 docs/variables/MarketplaceMetadataAttributeSchema.html create mode 100644 docs/variables/MarketplaceMetadataSchema.html create mode 100644 docs/variables/MediaAudioSchema.html create mode 100644 docs/variables/MediaImageSchema.html create mode 100644 docs/variables/MediaVideoSchema.html create mode 100644 docs/variables/MetadataAttributeSchema.html create mode 100644 docs/variables/MetadataLicenseTypeSchema.html create mode 100644 docs/variables/MirrorMetadataSchema.html create mode 100644 docs/variables/NumberAttributeSchema.html create mode 100644 docs/variables/ProfileMetadataSchema.html create mode 100644 docs/variables/PublicationMetadataSchema.html create mode 100644 docs/variables/StringAttributeSchema.html create mode 100644 docs/variables/ThreeDSchema.html create mode 100644 docs/variables/TimezoneIdSchema.html create mode 100644 docs/variables/timezones.html create mode 100644 tsdoc.json create mode 100644 typedoc.json diff --git a/.changeset/swift-days-wash.md b/.changeset/swift-days-wash.md new file mode 100644 index 0000000..a3286bb --- /dev/null +++ b/.changeset/swift-days-wash.md @@ -0,0 +1,5 @@ +--- +'@lens-protocol/metadata': patch +--- + +**Added** docs generated with typedocs diff --git a/README.md b/README.md index 5790834..074a545 100644 --- a/README.md +++ b/README.md @@ -5,17 +5,23 @@ Schema validation and TS types for [LIP-2](https://github.com/lens-protocol/LIPs - [Features](#features) - [Installation](#installation) - [Usage](#usage) - - [Publication metadata](#publication-metadata) - - [Mirror metadata](#mirror-metadata) - - [Profile metadata](#profile-metadata) + - [Compose](#compose) + - [Publication metadata](#publication-metadata) + - [Mirror metadata](#mirror-metadata) + - [Profile metadata](#profile-metadata) + - [Parse](#parse) + - [Publication metadata](#publication-metadata-1) + - [Mirror metadata](#mirror-metadata-1) + - [Profile metadata](#profile-metadata-1) - [Extract version number](#extract-version-number) - [Format validation error](#format-validation-error) +- [Types](#types) - [Narrowing types](#narrowing-types) - [`PublicationMetadata`](#publicationmetadata) - [`AccessCondition`](#accesscondition) - [`MetadataAttribute`](#metadataattribute) - - [Useful types](#useful-types) - - [Legacy metadata formats](#legacy-metadata-formats) + - [Other useful types](#other-useful-types) +- [Legacy metadata formats](#legacy-metadata-formats) - [JSON schemas](#json-schemas) - [Versioning](#versioning) - [Adding a new schema](#adding-a-new-schema) @@ -48,38 +54,11 @@ pnpm add @lens-protocol/metadata zod ## Usage -Assuming we have 2 JS objects: - -```typescript -const valid = { - /** example of valid metadata **/ -}; -const invalid = { - /** example of invalid metadata **/ -}; -``` - -### Publication metadata - -Publication metadata schema is a union of all _content_ schemas (e.g. `ArticleMetadata`, `AudioMetadata`, etc. but NOT [`MirrorMetadata`](#mirror-metadata)). - -Use it to parse the metadata referenced by `contentURI` of `Comment`, `Mirror`, and `Quote` publications. +### Compose -```typescript -import { PublicationMetadataSchema } from '@lens-protocol/metadata'; - -PublicationMetadataSchema.parse(valid); // => PublicationMetadata -PublicationMetadataSchema.parse(invalid); // => throws ZodError +#### Publication metadata -// OR - -PublicationMetadataSchema.safeParse(valid); -// => { success: true, data: PublicationMetadata } -PublicationMetadataSchema.safeParse(invalid); -// => { success: false, error: ZodError } -``` - -You can also create compliant `PublicationMetadata` objects via the following builder functions: +You can create compliant `PublicationMetadata` objects via the following builder functions: ```typescript import { @@ -108,7 +87,83 @@ const json = article({ > [!NOTE] > Use the type definitions to explore the available properties and their types. The builders will throw a `ValidationError` with instructions on how to fix the error if the object is not compliant with the schema. -### Mirror metadata +We also provided a set of builder function for specific metadata sub-types (list to be expanded): + +```typescript +import { geoUri } from '@lens-protocol/metadata'; + +const uri = geoUri({ + lat: 51.5074, + lng: 0.1278, +}); +``` + +#### Mirror metadata + +You can create compliant `MirrorMetadata` objects via the following builder function: + +```typescript +import { mirror } from '@lens-protocol/metadata'; + +const json = mirror({ + appId: 'foobar-app', +}); +``` + +> [!NOTE] +> Use the type definitions to explore the available properties and their types. The builder will throw a `ValidationError` with instructions on how to fix the error if the object is not compliant with the schema. + +#### Profile metadata + +You can create compliant `ProfileMetadata` objects via the following builder function: + +```typescript +import { profile } from '@lens-protocol/metadata'; + +const json = profile({ + name: 'Bob', + + bio: 'I am a Lens user', +}); +``` + +> [!NOTE] +> Use the type definitions to explore the available properties and their types. The builder will throw a `ValidationError` with instructions on how to fix the error if the object is not compliant with the schema. + +### Parse + +Assuming we have 2 JS objects: + +```typescript +const valid = { + /** example of valid metadata **/ +}; +const invalid = { + /** example of invalid metadata **/ +}; +``` + +#### Publication metadata + +Publication metadata schema is a union of all _content_ schemas (e.g. `ArticleMetadata`, `AudioMetadata`, etc. but NOT [`MirrorMetadata`](#mirror-metadata)). + +Use it to parse the metadata referenced by `contentURI` of `Comment`, `Mirror`, and `Quote` publications. + +```typescript +import { PublicationMetadataSchema } from '@lens-protocol/metadata'; + +PublicationMetadataSchema.parse(valid); // => PublicationMetadata +PublicationMetadataSchema.parse(invalid); // => throws ZodError + +// OR + +PublicationMetadataSchema.safeParse(valid); +// => { success: true, data: PublicationMetadata } +PublicationMetadataSchema.safeParse(invalid); +// => { success: false, error: ZodError } +``` + +#### Mirror metadata Mirror metadata schema serve the purpose allowing mirrors be associated to a given Lens app (via the `appId`) as well as specify some operational flags (e.g. `hideFromFeed` and `globalReach`). @@ -128,20 +183,7 @@ MirrorMetadataSchema.safeParse(invalid); // => { success: false, error: ZodError } ``` -You can also create compliant `MirrorMetadata` objects via the following builder function: - -```typescript -import { mirror } from '@lens-protocol/metadata'; - -const json = mirror({ - appId: 'foobar-app', -}); -``` - -> [!NOTE] -> Use the type definitions to explore the available properties and their types. The builder will throw a `ValidationError` with instructions on how to fix the error if the object is not compliant with the schema. - -### Profile metadata +#### Profile metadata ```typescript import { ProfileMetadataSchema } from '@lens-protocol/metadata'; @@ -157,21 +199,6 @@ ProfileMetadataSchema.safeParse(invalid); // => { success: false, error: ZodError } ``` -You can also create compliant `ProfileMetadata` objects via the following builder function: - -```typescript -import { profile } from '@lens-protocol/metadata'; - -const json = profile({ - name: 'Bob', - - bio: 'I am a Lens user', -}); -``` - -> [!NOTE] -> Use the type definitions to explore the available properties and their types. The builder will throw a `ValidationError` with instructions on how to fix the error if the object is not compliant with the schema. - ### Extract version number A convenience `extractVersion` function is available to extract the version from a parsed `PublicationMetadata` or `ProfileMetadata`. @@ -206,6 +233,8 @@ if (!result.success) { } ``` +## Types + ### Narrowing types Every time you have a discriminated union, you can use the discriminant to narrow the type. See few examples below. @@ -293,7 +322,7 @@ switch (attribute.type) { } ``` -### Useful types +### Other useful types The package also exports all enums and types that you might need to work with the metadata. @@ -354,7 +383,7 @@ import { } from '@lens-protocol/metadata'; ``` -### Legacy metadata formats +## Legacy metadata formats The package also exports parsers for legacy metadata formats via the `@lens-protocol/metadata/legacy` entrypoint. diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..e2ac661 --- /dev/null +++ b/docs/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css new file mode 100644 index 0000000..0bd3b18 --- /dev/null +++ b/docs/assets/highlight.css @@ -0,0 +1,99 @@ +:root { + --light-hl-0: #008000; + --dark-hl-0: #6A9955; + --light-hl-1: #795E26; + --dark-hl-1: #DCDCAA; + --light-hl-2: #000000; + --dark-hl-2: #D4D4D4; + --light-hl-3: #A31515; + --dark-hl-3: #CE9178; + --light-hl-4: #AF00DB; + --dark-hl-4: #C586C0; + --light-hl-5: #001080; + --dark-hl-5: #9CDCFE; + --light-hl-6: #0000FF; + --dark-hl-6: #569CD6; + --light-hl-7: #0070C1; + --dark-hl-7: #4FC1FF; + --light-hl-8: #098658; + --dark-hl-8: #B5CEA8; + --light-hl-9: #0451A5; + --dark-hl-9: #9CDCFE; + --light-hl-10: #267F99; + --dark-hl-10: #4EC9B0; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +.hl-9 { color: var(--hl-9); } +.hl-10 { color: var(--hl-10); } +pre, code { background: var(--code-background); } diff --git a/docs/assets/main.js b/docs/assets/main.js new file mode 100644 index 0000000..01bcad5 --- /dev/null +++ b/docs/assets/main.js @@ -0,0 +1,59 @@ +"use strict"; +"use strict";(()=>{var Pe=Object.create;var ne=Object.defineProperty;var Ie=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Ie(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Pe(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s=i?r.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",B="mouseup",J={x:0,y:0},fe=!1,ee=!1,He=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(He=!0,F="touchstart",pe="touchmove",B="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(B,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){D||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!D&&this.active&&n.target.closest(".col-sidebar")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var Z=class extends C{constructor(n){super(n);this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let r=Q.getItem(this.key);this.el.open=r?r==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let i=this.summary.querySelector("a");i&&i.addEventListener("click",()=>{location.assign(i.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js new file mode 100644 index 0000000..1550c6f --- /dev/null +++ b/docs/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE52aXXPjNBSG/0uvt/QDWGDvQj+Ysm2zQ7tlBoYL1VYSEVvyyEq6WYb/jmwntr7OOQpXmdH7vo9lSbYsKX/+c2L4F3Py4eRKyVIYoeSVqhumRavkvOGaGaVP3p00zKysictN3Z4h1m9Wpq6sfy1kefLhx3/fxfznXcNBYifCjBtZ6F3T+T5ptRUlj6oWO2DaA9NrbpqKFfyBG1Yyw2bGaPG6MfxatFbYpeqaGUOuy0vBZptSqI+dFuI9NYfyIGqerGjkIGh3NVtylOY5CNqLbX28bp4DowWtnAYmTDTzXhRctijRsSA8obXST8WK1+wu7lNPhSmPC2OfBKNZYVI1CmSYY8f+QlQcqk4gI5zNayUKNjzq0nBpfmdaCrmMiJAxi/3AhLxVxaZFsKMniwjeeWyBec8rzfn1rdI1MyHI1RCCZrK1vdXVfz+aUv0K2GDuC6tE2d/FTTewJl5Rsbbl7Vlg8EkXly5rVhS8bccX8MQytgrtWSD7pMvzn364+P7SpZWltv6IMhST6VptpInCfSmZlSV8E45Gc3b9yylmDOVkvmnccbcPd4VkUhtRVOOkEjF8OZM27yfDuEM8lWTZQRV3S1d4ekFm+wkIuidXzCJB9+NoFOdnpSrO5DhThKxQp3hXK/tuivt8X0yneWG15Z2EGil25DOB5ooMJFFVFS8M+ISFOsW7ZoaDHeCJOSRjvyFSkK6cyt/Ur7yEmt4Ts0hAg7sayRm+YXn5yRJikqdms55sc7rzdgAbZJKm2PxNct2uRAMOhaSJJOvi8jyDnbaR9K39IgH72BWzSFAfOxrNqYGpclIoxq195tQb2FaBTNF+4eqTEvHseyjPyH/+7S6RtqVUdlhWAP3jiVkkoH9cjeL8+jR/BN9PnkiR7oVcQ7fmajkc4MYciaaYaYn8ke9ilK8fxbMvEfvSXeLQg4kmb3lrNGc13HqhI58JtmRgIImqYFU0QIZSKtttJJTqLXpwD+U5+WAjIoUKLP+DCj4ImJe8zrg7EVFHJYvRP9ZJRq9kMfqdiCSjV2gG1VBHt46AJyxXy+EAY92RaEq3ioTr46p5LLBOjkiRHrl5U3oNzKO+SrIWhv76SJpI8sZ++mlwZAQyRZtrsHaORFH2G0DxmmUUMgnQkAjkI2nX9ldUUY+mXZlsYMD5ai6LHCmgkbzCtEFFz6uo+YgrJcaBK9JrfHefDhoRsYWidjt05aay65JZ+femNbX9vI46MGkiyWIpmdno6GkchdOLcxpSNxUHh0Agk7QGmcY9MYsEDHdXIzlG6R1YI1fMIkE1cjSa0y1SwVdpIFO0ZxYth20RmbI/c1mBDRPquTygeQKZpPXb0sntOkfKo4B36Kl5LOjuXJEkiZp/VTIxa00K/ap6VmueeOHti8l0vFMfkWLLEVSooSIHyXxTM3PPWWtmWrNo6ghkipZY2dsiurWHEz6gpTwxiwS0jqvlbu8Pxz8Tacu0YK+Vs9E/OHzet9g+MoxMOxG0twMKcxM2BOptW8DQhA2BYktA+Bp06rhLHnUl+gLjAhThBh4K169FCZzjoXD9kCdwjgfF5ffa8V0Vn6HT+MiMXcBbeyLshA/BBqsymJs0IuBgDQODk0YMHH9fI3DIjFwg+LqC4UkjAh4+AmCeq2OY8SMAQQUeBGf21jbFGUUEwJLn0YuN7Gfx9szVw4n0/XcuaDiqTTIGCQv7n4JOtD+9vcSi/t6cE4235rxgMR4uptKTiiB4d1yWSvcCFuzOYJLBTsCCX/r/1bzY9TrQYb4DQS2gc5mJFVjQ/l/0fzL5Q5XBfz1cmutAUMvojGeCHDS0Ltb0WQsgbhU0LPyN2inbC6cX75GsXeCvU9GuHI0d9vPT4YOKIGqgveroTCyIQb01KEhU4nuREylpRLtApbYPJ6Ajo5hmmJxSiL1Eh/NuETSj9Wu7bY4UrhewYLcbkQx2AhI0+3V6KnvQsHg/xyXDvYJFp6VhMj/JCGTrn39M8W18/GGDf/0H42RtWjcsAAA=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js new file mode 100644 index 0000000..2e8020c --- /dev/null +++ b/docs/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE7V9W3cbOa7uf0nOY9oj3qpK/eZOu7u9J7GzE3fPOcerl5ciVxxNZMm7JCedmTX/fRfJogSigLpQ0lMcFQiwCBAEP4Csf7+o1t82L368/feLL4vV/Ysf5WSaCyNfvVjNHssXP764+bY+374pZ5vteVXNvr949eK5Wta/b78/lZu/oadnn7ePy5pkvpxtNmXN9sWL/7wKnDO9Y1r+ta1m8+0fZbVZrFc7np+eV/Nt/cPmbzHBULazaruYL0uCX/NkMKPn+8WaYmN/H8pk/rmc1z8+XFIvuH84eMweP5b31FDZ3wcz+VquthQT+/tQJovH2QM1yO73H0Q2lM9ysfpCsLE/D2fxtdxsq3L2SDIKD4eye1yQo2N/Hspi8zSbU4Pjfh/MZLuuvlNM7O9DmWzrSXS9WlJ8wqPBrD5XZfkzxcg9GMymmq02M9eU4rV/OpTh18V9Sc1T9/twpVfVuiLVbh8MZfNUrT8tSOfTPOlkJGSx4/THbLm4n9m2F1HPmoZ/Q8+7+U7kvovunyHcXjaUgOWrF0+zyjqPdv/20vDice7d7vWTGwi0dsQPO9+ixdf6YYYreDSK5+udR6YZt56P4n5hvTTNGD4ax9M6bYYneDSK56X14TRP+GgUzze1Q6dZgicjOQbPzvFFz0dxf7vghhU8GcXxg3X+NEv4aBxPuxYwPMGjUTxvmnWBZouejuPsFgqGL3w2jut+yWBYtwhG8f/DriM0Z/hopHVZp8nZF3g2ius7v8bQbOOHQxe0T+vqcbb9/+v7C2Z9jAk62e4Xt7fldlYvHrPz7bZafHzeljd1F3fMy9XzYz0MFE33MpftBPx0ff3m4vxqMMuX+wb0ckf3mJT98/nNxXDBDfXBUq9+f/vTxfvhcnf0B0v+cPP+8urX4ZJ39AdL/q8P1yNU3FCnSVX7WfbTer0sZ6sd5Yd6G/c42/Xj66xazD4u6xlHE46a0ZgFmtP4cfesNkbtx+7ubgvn3OP6/rnusx8p/+wHMyie/DpbPvfwOXM0Pwh29JvOMBL6O3rWkKRw/1J+72HuKQbyBoby82xb9lsJQTXKRKL2yD6iZ8c1juJIxlE0xiFPZRyFM45k/n3mUVjzGGPawECunuuov+o3EZJulJEgDshM0NPjGoqcHslS5LQxFXMqU6kluH9FqqfqM5ZagLUWlWQtH2r1rB76rYWkG7mriDi0NhbR0+Nai8qPZC0qb6wlO5W11BK8tYxQ5yhrqQVYa9FJ1mKjnX5bIahGWUrUHtlJ9Oy4ViKyI1mJyBorSdXhgK56K0k1wz4jqflbIxmxvAEjaUW9rKEwlOM2vZgH3vji50M3qQ/l+vdqQWxO/YMfxAhG79Y0/B8eDWdmn1Kc3O8/yHFY13o+W+Lx8j+OQwtX8+r707a8904cMURPx6EwM8yt/mUcnvv0dHmPeLjfxq1di4fVbPtctVat8PsPYjLOamfVl/v1txU21ubnUbx+f3+J2NS/9FgU5vFrbdMtNv7HsXxiW99xcj8f2WFrjlXk7JazbQ+bM0+S4kmXwN455o5kIPOW/d7fV+WmlYrwvx51OIeNpfUOi23n6nEGiFKGdL5+Xm2rbhF7mhQJHl7cgqQ3JQNSpUixaYJyixVIScKUKdKq8gEmPykxO5IU/k/rzXa2fL2+7zSis4gs0eYtwLBdPFK4g/15ZCbrkZ5C+wcjc3mzxaq1ojS/jts9l9tv6+oL3bv44ZH3zsN2Q3P0pjSrs4YsGYeb9c8PK6YhGxOStoKJ9Zeyrbrm13FBRRSENS7ZBWA9cdzojeswTa1Xrqapm9UZIEtR1H05XzzOlt2aUmeALHXJe7TOHQ+v+/HI8cOx9ntngSZpAkTGRPMPNIkj2mTpWra/+31cQvD543Ixd1UabY7w2cgYtOlN2LD9XP+7WDIJR0R05Fk3zDAW3b5RibNFaugQldMwzC1Nve1IlPARVCEyAjxJUqywmEebJUbAniwtTPxaVu+GSUK0SdM04Ac9DrCerDvKdBRvFm1bOUGWKDFLgOYRC9GQdIdM6+75fOSJPBk0kf/PJn57mtXZnSdLn3PLctVjPJMzS5MuYdPCKRgxO8IfpsNFFVin3hqAofp0OXo6tLzizfnNxYebAbxe7ijpjuPe0RNgv1L1TwKONnXd5CZDm2Jg7Qto+boO8+px+MesWkEwrhlOjm6okq4+/PKPUTxfNi0YVbH9pqtCLq4+XN5c/oFLYXq6AJsdpx/vri/ftApj+nqxa5TeB4AErz5tr7+tymrzefFU098vmOJnkm444NyUGA8SxdIesi8azv4lS3BGQVxg6PmG/OsPyd0cse/d1SgJL3DWE8O19gzHfBnI/YRvFNUcLpfrb13WiyiOY7M005fo5z77xOT4ZcbZ4qg+ddtdT8d6bMxTH9zDHZsj9RGm21b3XSYDHw93qeuqiyd42sNyv/w3Oba6SR372CMqFVqa2gSDo7LLm7t3769vrl9fvxnG9CVqQmuF6DL1Zleftq8b3Ioo50VPh77TxfvXuRQDeL3cUdIvgXvHSRPCmIHiGtKx8vYjtrMeYryiZ4NDvl9u7q7/cXXx/sNvl+96Gb7E5PSbxL3kxk1OxkhuN0iXfX0+SjIiT5ZbT5tf6iBxjGyqSbL8X67fvLnGAT4hdEeXLKn2DW8uXuPtHiFqT5gs6/zq5345nihZxjXeDRAirvngn5PQyhp1Rv1N8oiiOXIOaVil7gA+TblbKuIxKPdRSwl0yXmqObUK9Qi76QqdekrAfFqqJy9Wj96ebjSKs7ON1+vHmn6xsUeZymq2XePwoYNy8Jr737+f4wCij+3L0KhnzhD9p1ey65u7pH7Ahkfqy6/vL85vLt7f3fzWOlHU2x3U9gQ9urt+nzZSHJMj9fHNxYcPSUMGGx67L8mDRXI4pHet6odqLie96wVDdeRk67Ck2gA+fsUYUcAcZ1bi7DIjwlMdsligkWbkQMLE5O7FetavYYrmyPodlmsZwOeMKn04aj1JLSPUk4zQMHcwtm/wWbojJ7vkcRSgZBOSpR5uaiOHjJgd4SFa+IXB9fzYo6dHNvlh5TkD+PgRTz2ChGA0RkQPStY70K/r9uV8y400fnzcoR5WstbP5owq/Blu2WTlCy0I0yZtAj4vNiAr1PdqLepETX9YPD4tS07R6Om4wjkKTm0KvMCjdNtheJElzmBIon4NMa5uOd2YedSqJ46oFtuyWuA8MSsX0KfIxuq6JoBq3wPw5FBlYVZ9uoKdGq4qRkq3pmCjJEVxUnv11Cm5Navm8zqUYSdW/HTUfH2z2O5x+r+X+I4+/HhcZXY4F/Rutv3cqs6OHqb3+cO23iKVD50dDzRHDg6GIWRPOF9D8zoDdCkrSUlqkZGFiZPCcMYmGZGIPHmFLmmj6n7RhvqgvcB+3e01vk7aI+8JhkWog4xQqZ0RHqqeAWZYS4uI088XjDDEWig2xNRN0AhD3L9qMMQRQtvXH71ZzMvVpuvyI0AxFL19/fp6ILOXnpTuPtVHRt7dT/9vuERPfAyZd61UUbfYu46s0VjJr0dKfn245Jufrt7cvb77+e7dm7s35cNsObQLVMMj9eUmuTM3x+/NVfLQXJ1ibO6ukhV1dQpNJXfn5iT9+XCebjtx2yP2KH2MUOOjWXRqj65OYkV+2O8fWkVLA51P0/K43ielOzcn6M9V+vBcnWR8GgtIUtfVSfSV3qGb0/QoeJKkLqHGR/dDqZ06wUhdHWBMuO0xenSVHAjhlsfqTWIo1Gp6pP6kBkOtpkfTVtpK1mp6PH2ld+j4EdHVISER0fiYfTpgnE4QFV0dEBa12x7XF412jq2mR/ZGSR06fmx0dUBw1G57ZI+UprSTrGjJARLR+OheKa1TJ4iRrg4Lksjmx/ZMiWZ+cJ+Iu/0AYe/tfi3agYda7GVo5fZpOZvvjofvLvH7ebGpH3ynQM5hrQYffiBvQB8ho/dO9IFvSZ9DJW9JH9O7vnvTD+kddWf9mL5132I/umfQjDsa8/bc22hUnrKL3U66zxh1kR65rv9Yd+LI5lKc5DrNe2KGM4Ji0qRCm2q2GFDZL84g4UBB3WY3xtqOY2T9tnVkkxpWGHpfbubV4qk3RycnZ4AU3xg/PD/317asVrPlnZXUIw/SJgt0//QIsjTJAgZeUFOLARfUpAqLP9THyPFf7Ut+n1Xd3up4iIoi4jEiYf70fjFz3/j6u32C4yz4cGjw8Pb3D5ftpF6L08tAxwVnUcfoc4PXP78+b12eQsnaU6ZLO//958vrn66v/z5AHqRNl/jH9eXri7ura+IjOG2REXG6zA/XvxPJ4La4QJcu6frmN+IrO21JgW6kJMrG3y4e6RIBTDDU1v9x/scwXi89Zd877DrISbv7o0M7LYkN9WFS375TAyV6ysOkXf/6652bPQNlQvpD31OPkgzpD5N8fs77y1impzzQii5+ejvqRaMGh8n+5c3gV21IE+RFO/dA17Fhj0nGRZq7xjjA3D04clx5pPMusjnvkrND3BMKbcvHPgENzSnDOgnDuhGXurXvVOyTE4iSdnXPVf9RhloGoEsRs/SQU5+UPVnSYFW1ZW971bInS1J/tV1sek6316oPVCkiHspVz4WBtYRAlCKgKufr6v7N7GPZE8fLs5g0RdgXGLwzUhqaJMv6Xi3mvTrfUaXtQtz3cLsitIhgaIT201t8mwjD66Wn7Fhv4g6S0n69/GWgNE95mLTfLuiNFiGuIT1M3n+9u2h/nJKW15AeJu8d8S1MWty7zq9gDpP24Y+h0jzlYdJuLn8ZaioN6WHy6iBu6ERoSBPk4cjL0XVHXoBkfOR1GQEyIPJyD44ceR3p3Ktszr0mg1C9kZdykVf62YGBsZeK7nxOvcpmttzC7x1xkgLVyeIiFeKiMeOGVjD3DeuuFSwiGLqC/frmhvQUbWYvG9KOmRt3kZV399Pl1fn79lkEXuy+xWHS32oSUSGkesoDpV0PlnZ9BGnv9FBp7/gM0nBp9GpNiutbrQfIu/51qDhPeai0oZrzlIdJ++/fL1///ebyLQnEEjIh/WGSLfgyUGhDmiAPr9uOrnvdBiTj123XmFq33YMjr9vDvpc2gI9ft1NRhv51W/t1O/Xw3dB1W0frdnKUMGDd1s26fcCNQr3IjPbITLKIYdiM3mEzyYIGRSF6F4WkfYX0fPXdzSN27sYEo2ZuaIrmbfi5kxfoov2Y2b/WK2Cl+97tng1ldtM0uLxn3xiTjHrnfWP01vsHg68rvvlcleXPv7jv6yGPDh8NDQsf2mFhi83Lh66AMOoQKePTx796RXiaVAlfq8deCZ4mVcL64z97JXiaURJaluLIqG+kgSfHXdnUsM/Bf4otjuZ0tqNK8W3P4JPBDH9PksLcVjmV1e895RC1CEiYIuhfi6d3s+3nPjF7slMtA7WQsAykfd/emxzvEsHjce7QNWRqquKHxzV1fbxvGmnwTaPUMr3ebxrp8E2jVAm9hVO6KZxKljC09EzHpWfpH/caFp7qqFJLpOYnB1e6aVTplvx+/cVhOhSHpY/h4OowjavDkmUO+7qWhl/XGmOTrSiz2i7m7IfT0NMj7xSP5mNkcDGn8i/yrCE5TVHmWUNySr8iz2LKU255zyLC01bOniHSExWangWaE1eZnmHa0/kQeQbpUv2HKwpivAd8duQA5XjxyT48OVl00gQnJ4tNmtDk1JFJHJicOC6JwpKTRyUoKDldTBJCktNHJDggOW08AsORdG/y+nM5r588XHIfr2wTHNevZEfzK9nOr6QCzL1+JfN+JZV/r1/JvF9J5T/Ur2SRXzkxHJ9Bv5J8795Qv5LFfiVVXr9fyRq/kjx6g/1KhvxKqsRhfiUDfmWEpNY1sI8fy3vGpUTPjutNhgGGQ7zJdOdNUveVvd5k6r1JKv9ebzL13iSV/1BvMo28yYnRkyn0JqmyBnuTaexNToecTBtvcnrcZIq8yWlRkynwJiMkta6ur2dizbwOQ87v//m82T7W7fDd0iTNkfMRAzPt7Zwaze0sokzRQmBw/ekTzMv0iNtRpzr3rzUh59zhs+MOP/50yQHeXewArOST7L3uXXgMK1lAr38XHsZKP4s/0MGLCMlK/0TTMA8voiMvqcIGu3gR41nJAvt9vGggrfQBHOzkBUK1kkUO8/ICAFtjRGG/4quuab8SPTuyXzHH8ytm51dSP/vT71eM9yupAvr9ivF+JVXAYL9iIr+SKm6oXzHQr6QKG+5XTOxXUgUO8Cum8SvJAzjcrxjkV1JFDvQrBviVEaLa3w5ZfWHcCnx0ZK8y7ONWg7xKvvMq2cm8Su69SqqAfq+Se6+SKmCwV8kjr5IqbqhXyaFXSRU23KvksVdJFTjAq+SNV0kewOFeJUdeJVXkQK+SA68yQlTbq3wtN9uqnD2yvgUTHNnDHA/tEnu4K7Ugpd/DNHhXqoB+D9MAXqkCBnuYGPFKFTfUw0SQ18nLhQTCvJLvT+j3MAH0Sh7A4R4Go16pIgd6GAh7jRDVOkqyYGEW+OjIRULH2w3J/W4o9TBof6FQsxs63QVuzW4o9VjM4HKheDeUKm5oxVC0G0r+KPDwqiG0HUo+ZNRfOBS2Q8kjOLx2CG+HUkUOLB+C26G0y/AWVbWufF30ZesyvOjh0FMab85vLto31LVZvdwR0r1GXSOrvj1N/x2bBNmoKvCYQcvzwodH9r3Hq4aQ+3KIVKvs971NPcQIAXtbBN9LfDtbrH5Zz583yIwokqF2+cflzxf4/i+W38tATb8F2VVS6uXb81/xEVpeaqA+VOr5+5vL12+Gy93THyr55uL/3txdX73BB+l52bDFwe9N3PHW8dadF7wNl/rm8grfkMkLbYgPlXnx9qcLfC0iLzRQHyr19W8Xr/9+efXr3eXVYNlxm4Pf+4+LK7y4dLx3Q32o1LeXI4Q2xAfPpPfnVx/OX99cXg8f67jN4Xb9R71Av784x8fxu6wbNDlU/offrt/f3I3z23Gbg3Xw2/uLi7vh82xPf/C731y3LiPpeOuG+mCp785fD181AnWSVHLdZwJRgmLoqt9o5I6MSjm+L1utel+RiFPb6/HIXrRaHdoLu96N7UPc5sAegLVgZD/Ilgf2xq2KI/uB2hzaA7s+je1B3ObAHriIc2QPUJsDe2ADopEdiJscLD8sWaN70W54YF9s6DCyF3GTA+U7jz6yA6jNoT2wK9nYHsRtDuwBiKHGrhpUy0N7E3ZHY/vSbndgT1xMNbIXqE1KD1qVn0/8N06iZ0eu9DweCK72IHjyXUS9SIxqUPBkCb0wuGpg8GQJQ3FwFePg6fcuDgPCVQyEn7zeUCEgPPn9+pFwFZDw9DEcDIUrDIUnyxyGhSuIhY+xyZaD2a6r75yDgc+O7GCOh/SqPdKbnMfpdzAN1Jssod/BNIffkiUMdjDx8bf0C+IGOpjoAByuNT2Bg0FH4JLfb4CDCYfg0sdwuIPBx+CSZQ50MPAg3BibbF0pVGvjerXkfAx+fGQ3UxzPzRR7N3OyI3G1EO9mTnYorpbg3cypj8XVgiI3c+JjtrU46GZOXolYy4vdzOmO2taiGjdz+sO2dhhjN3Pa47a1POBmRtgkuHaxmq02s7lDXhsnQlzPzVANBVYv3r/O3VdEh/J8uWtBvxDXa066+97kGOH4A5WpsqmvuHXK7v6cW7/s1gLSboHXkDbFcZcRPez7sYNufxH7ZeRkR2RqIX4ZOdkZmVqCX0ZOfUimFhQtIyc+fVeLg8vIyb/DWsuLl5HTnb+rRTXLyOkP4NlhjJeR057Aq+WBZeSAozL+AnXazUTPjuxgjne0V++P9iZHQf0Opjnbmyyh38E0h3uTJQx2MPHp3mSHNtTBRMd78RGGEzgYdL43+f0GOJhwwDd9DIc7GHzCN1nmQAcDj/gOsMk/X72oRZV/vfjx3y++ltXGWuGPL+SZOrMa/7Qol/d109swD+brR3tfw4s/m2d/lPPturIUnuRvdTB3O3llpmeZzP/889VtaOEeuB8cWR2n3AqKTERktbe5la+MPjNiGpHJiKwOx28VRaYistq132pKqI7IagXdGoqbicjqsb3NKLIsIsvr/+WvVE020RFZHpHVC/htQXErIrJaKbdTimwaD68dbTGhCAVShNOEICljXdgN1q0gtSFiddjt0a1QpHpjjdjV9laQOhGxUuy0uRWkWkSsF2v0t4LUjIhVY09+3oqclB5rx8ZXt6IgKWMFWUd5K6YkZawju++5lRPKNGSsI7s7u5XkdJFovrgJI0nKWEf2I2K3ktSRjHVkP1tyK0kdyVhH9kTKrTQkZawjWz99KzOSMtaRtIqQpI5krCNpFSFJHclYR9IqQpI6krGOlFWEIv2ZinWkrCIUqSMV60hZRShSRwq5NefXSB2pWEf2wptbRepIxTqyCdNbRepIxTqymY9bRepIxTpSVhGK1JGKdWRhzltF6kjFOrKfFLhVpI5UrCN7I/utJnWkYx3Z3fGtJn2djnVkw9xbTfo6HetIW0VocvHRaPVxyw+9/sQ60lYRmtSRjnWkrSI0qSMd60hbRej8lTRnk9zElLGOtFWELl5pdWaUiiljHWmrCD2lPJiOdWSsIszklc7OMhVTmlhHxirCkPPIxDoyVhGGnEcm1pFR7LubWEdGs+9uUJBg2Hc3sY5Mxr97rCNjFWHI+W5iHRmrCEPakol1ZKb8u8c6yibsu2exjjLBvnsW6yiT7LtnsY4yqwhD2nwW6yizijCkzWexjjLDvnuGYrmMf/dYR1nOv3uso6zg3z3WUWYVYUj/mcU6yt08Iv1nHusoF+y757GOcsm+ex7rKFfsu+exjnLNvnse6yh30Tbp5/NYR7kLuEk/n6OQ2yoiI/18Husot4rISD+fxzrKrSKyem6KM2HQG8U6KqwiMnJuFrGOCquIjLT5ItZRYRWRkTZfxDoqrCKynNxJxDoqrCKy4pWqLSSLCWMVFVYPGamiIlZRYfWQk9uOIlZRwauoQBsjXkVFrKKCd3VFrKKp1UNOLjLTWEVTq4ecXGSmsYqmVg85aSDTWEVTfjmaxiqaWkXkpClNYx1NrSJy0pSmsY6mTkekKU1jHU3d1pV0S9NYR1OriJx0S1O0f7WKyElbmuItrNVEQc53/wzSWl0UNKAwQdvYidVGQe9jJ2gjO7H6KOid7ARtZSeaVat/BmlNRx/QdnaSsYbln0Faq5eC3k9P0JZ2UrAezT+DtPzU8s8ArQMYCnqn3gIfnN5IYxQYfnAgQ0F6NoEBCMFPMYEhCMHHfAKDEA5qYMYMwxAObCgKmhbpzcENBQnsCAxFOMBhSs8LDEaIDr0hOEI40GFKzyEESAiPSJDYhZAYNrK6mZIuVCBQQjjoYUrPNwRLCAc+TGlbR8CEcPDD1LxS6kznBaJFenMABL2CCgROCAdBTGn7RfCEcCDElEabEEAhZIfeEEQhHBAxpdZxgTAK4ZCI6ZQkRVpzUAQZHQiF0T4H901oi0RAhXBwRO2TyeFFWIVwiETtlGnOSG8OlKi9Mk2MFOdwidot08RIcw6aqP0yTYxU59CJ2jHTxEh32uO0tFEg9EI4jKJ2zeTQIQBDOJii9s00MdKg7nCXGiO2zl2SmwCBcAzh0ArGBSIkQzi8QjCYNQIzRAeaIRCcITyewXQYKc/BFsLC4VSPkfIcciEYRBzBGsJ4nJ0EigRCNoTDLwSDiyNwQzgIQwjaOhG+IRyKIQRtnQZD7m76CdoVIpRDGK8/GiNHQIdwcIZgYHKEdQiHaNRLEE2MNOhADUGD5QIhHsLhGoLGywUCPYSDNgQNmQuEe4hMdhgSgj6EAzgEDbELhH4Ih3EIGmUXCAARDuYQNNAuMpw3yTr8C4JBRNYxAxEQIrKOGYigEOEADyZ6RGCIyL36mAQOUl/u1UfbJ4JERO5zXbR9IlRE5D7dRdsnAkaEgz8EnSgQCBsRDgERdK5AIHhEOBBE0OkCkePMl5uAdMZAIJBEOChE0EkDgXAS4dAQQecNBIJKhANEGCtCYIkoeNRRILhEFB17BQSYiMKrj7YihJmIwquPyQQi9RU8/igQciIcPsK9HVKeQ0iYHSFCT0RRdMQBCEARHQiKQBCKcEAJ02EEoggHlTBxAIJRxFR2xAEISREdUIpAWIqYdgQuCE0RU9PhvhGgIqZ+4jE5X6S7aYffRKiKmHb4TYSrCIeeMDtIhKxIh54IOmUmEbQiHXwiNJ19RtiKnEg+JJIIXJETXnkSgStywitPInBFOgBF0Nk7idAVOcn4uEwieEVOeOVJBK/ICa88ieAV6SAUtsdIe762Q5PTXyKARfryDjrrKBHCIn2Fh008UpyR9nyRB517lAhjkYLHxiTCWKSv9NCk85YIZJG+2EOTMYtEKIv09R7cyCH9+ZIPbjCQAn3Vh6ZLCnDdh+QXPYkrP6ToGIxW8YfsGAxc/yFVx2DgEhCpOwYDV4FIX6pDuxdcCOIQFUEnfCWuBXGQiqBzvhKXgzhMRdDpVIkrQhyoIuiMqkSIi3SwiqCTlRJhLtIBK4LOV0qEukgHrQg6FSgR7iI97kJnAyXCXaTHXehEm0S4i/S4C51rkwh3kR53yWgNItxFetwlozWIcBfpcZeMKVJCGvS4C513kwh3kR53oVNvEuEu0uMudPZNItxFetwlozWIcBfpsJV6C0QT4zIsp0E6DycR8iIduiJyWoMIepEeeqHzYRJBL1L7ojlagwh7kQ5fETmtQQS+SA++0OkuicAX6cEXOuMlEfgiPfhCJ70kAl+kB1/ovJdE4Iv04Aud+pIIfJEefKGzXxKBL9KDL3T+SyLwRXrwhU6ASQS+SA++FLQGEfgiPfhCp8AkAl+kB1/o/JNE4Iv04EtBaxCBL9KDL3SmSCLwRXrwpaA1iMAX6cGXgtYgAl+kw1eYOA1hL9JXn9CBJYJepK8/IUFxiZAXmXn10VaEoBfp4BVBZ4skwl5kxm//JMJeZM5XC0kEvUgPvdCpJYmgF+mhFzpfJBH0Ij30QieMJIJepIde6IyRRNCLzPm9u0TIi/TIi00vmbNMF4gY17M69U0zmhipz4ErTI0wAl6kw1boHJdEuIt02ApZlS4R7CILr7yc7C/CXWThlccU4SLleeBlShsyAl6kw1YknWSSCHiRDlyRE9rgEPIiHboi6SSTRNCLdPCKpJNMEmEvsvDa0+S0RtiLdPiKpJNMEoEvcuprx2l3iNAXOfXJWtodIvhFOoRFTmgNIvhFOohFTphKaqRBh7FIQWsQATDSYSxS0BpEAIx0GIsUtAYRACMdyCLp0wkSITDSoSySTsRIBMFIB7NIOhEjEQajJvwmUCEIRk145FMhBEY5kEXaBE97p6YQAqMcykK7DIUQGDXx6iN3ogpBMGri1UfuRBWCYNTEq2/6She1hxGIGJWaO5hF0skghTAY5XAWSSeDFAJhlMNZJJ0MUgiEUQ5nkXQySCEQRjmcRdL5HYVAGCX8EQ66Qh+BMMrhLJLO7ygEwigHtEg6XaIQCqMc0CLpdIlCKIxyQIuk0yUKoTDKAS2SOVSBUBjlgBbJnatAGnRAi2SOViAURvnjN8zpCgTDKF/vwhywQDCM8odwmDMWCIZRzTkcWoMIhlGSh9EUQmGU5AvUFQJhlD+OwzgNBMIoX/NCOw2EwSh/JkfRTgNhMMofy2H8AD6Yo7z6aPvEZ3OUVx+Jjit8PMfBLJJGx1XrhI5TH42OK3xIR/mTVLR94nM6DmaRmjn9gxToYBZJw7wKn9ZxMIukz5cofGDHwSyShnkVPrPjYBapaQ+DMBjlYBapaQ0iDEY5mEXSAKtCGIxyMIukAUiFMBjVUfuiEASjOmpfFEJglDYdcwohMMqBLMycQgCM0nnHnEIAjNJFx6qNABilpx2rNgJglMNYuNmKABjlMBZJo7wKATDKePXR0wQBMMphLJJGeRUCYJTDWCSN8ioEwCjjTzOSpQgKATDKYSySRnkVAmCUyTvcEQJglMNYJA0JKwTAKIexSBoSVgiAUQ5jkTQkrBAAoxzGImlIWCEARjmMhZlTCH9RDmKRNHysEP6iHMZCHzBQCH9RDmORNNSsEACjMn8glTYjhMCoLO8wfYTAKAeySBqXVgiBUQ5lkTQurRAEo/KOLQSCYJRDWcgiUYUAGOUwFrJIVCH4ReV+/0f6Q4S+qAZ9IUEShdAXlfP1ugqhL6pBX0hARSH0ReXscXyFsBflq15o4EMh8EX540H0+CK1OYBF0ukEhdAXVfDHuBQCX5TDV2gdI+hFOXSF1jECXlQDvJBDhnAX5aAVTscId1FFx5qHYBdVdIBmCsEuyiErtI4R6KKKaYeOEeiiHK5C6xhBLspDLnQWSCHIRU07vCVCXJQDVWgdI7xFOUiF1jFCW5RHW2gdI7BFTTvAToXAFjXt2CsgrEVNiw4dI6xF+XNEdIfx8fAJr2ONoBbt4BRSxxohLdojLXTyTiOkRXfUumiEtGgHppA61ghn0Q5KIXWsEcqiPcpC6lgjkEVPcl7HGoEs2uEotI41wli0L3ShdawRxqIFC1JrhLBo0QFSa4SwaMEebdAIX9EeX6FzrhrhK7qjyEUjeEU7BIXWMQJXtMNPaB0jaEV7aIXWMUJWtK9vYXSMkBUt+NyCRsCKlpMOHSNgRTvshNYxglW0r25hdIxgFe2QE1rHCFTR/n4TOlWuEaqiJZ8W0ghV0R5VoTcQGqEqurnnhAyDNYJVtIdV6By8RrCK7jhLpBGqovmzRBphKpo/S6QRoqI9okKbJQJUtC9qYcwSASraYSaMWSI8RfuaFsYsEZ6iHWRCmyVCU7SvaGHMEqEp2gEmtFkiLEV7LIUundD4ChTNbwU0vgRFs1sBjW9B0exWQONrUDS/FdCti1A6tgIa34Wi+a2Axreh6I6tgMYXomh2K6DxjSi6Yyug8aUomt0KaIShaI+h0BUvGmEo2vBbAY0gFG3YrYBGAIo27FZAI/hEG34roBF6ok3HVkAj9EQbfiugEXiiTcdWQCPwRBt2K6ARdKJNx1ZAI+hEZ+xWQCPgRHvghC5U0gg40R3AiUbAic7YrYBGsInO2K2ARqiJzvitgEagic46tgIagSY647cCGmEmOuvYCmiEmeiM3QpohJjovGsrgCATnfNbAQSZaIeLSLq+TCPQROcdWwEEmuic3wogyETn/FYAISY679gKIMBE511bAQSZ6LxjK4AQE513bQUQZqL5ehWNEBPdVa+iEWSiC34rgCAT7XARSZcFagSa6KLjlLNGqIn21Sp0DaFGqIn21Sp0DaFGsIkuOi79QqiJdtAIbWoINdEOGKFNDWEm2heq0FWMGqEmeuoLbclBQ6CJ9tet0FePIc35KhWaK9Kbr1Gh6yg1Qk20Q0bom98QaKIdLkLmVTSCTLSDReg9A0JMtK9OoQs5NUJMtINFmLHFl7Xxt4caBJgYfzyIvi4VISbGgSJk1sMgvMQ4TETSZacGASbGl6bQZacGQSbGnw4izcEgzMQ0h4NoWnR3my9MoctZDcJMjC9MoctZDQJNjC9MoctZDQJNjC9MoctZDYJNjC9MoUtJDYJNjC9MoUtJDQJOjAdO6JJPg4AT4wtT6JJPg5AT4wtT6JJPg7AT4wtT6JJPg9AT49GTKa1BBJ8YX5hCX/1hEHxifGEKffeHQfiJ8YUpdA2lQfiJ8YUpdA2lQQiKcSCJomsoDUJQjINJFF1DaRCGYjoKUwyCUIxkoS+DEBQjWejLIPzESB76Mgg+MbID+jIIPjGSh74Mgk+M6oC+DAJQjGKhL4MAFKM6oC+DEBSjWOjLIPzE+Gtj6dJXgwAUo3joyyD8xDiQhNYxwk+Mg0hoHSP0xCi+Gtog+MT440CMjhF8YhxEwugYwSfGnwZidIwAFKPZKMUgAMX4s0CMjhGCYjR7d59B+IlxGImiK5YNAlCMv0+W1jHCT4wDSWgdI/zEOIiE1jFCT4yvQaF1jC+V9WeAGB3je2UdRMLoGN8s648AMTrGl8s6lITWMb5d1h8AYnTcumDWsDrGN8w6jETRtxkZfMlsc/cKWRJk8D2zDiVRdFW6wVfN+uoTut7dIAjFZP5qbXoBRSCKyXjsyyAMxWQs9mUQhGIyFvsyCEIxGY99GYShmKwD+zIIRDEZj30ZhKGYrAP7MghEMRmLfRkEoZisA/syCEQxOYt9GQShGIeTKPrkgUEgisl57MsgDMXkLPZlEIRichb7MghCMTmPfRmEoZiuMz8GgSgm57EvgzAUk3dgXwaBKCZnsS+DIBRTdGBfBoEopmCxL9NAKO67IV/LalveX/rvh9ze7j4g9O8Xd81HRWp9Opb28yL1qvDjv//z6kXtFf2/U/9vPSPcv7VBuH+L5vdpQ2dvz2z+aJ7YOxybP8IvMvyhw6Mgzl5H5P+o37L5w4Q/QqudrGlDbG+gaP4Iv4imG/aQvv8ja5rbE2HuD3t0w/8hG2IV+mML3/wfeaApmhe2VR7uDx2E6iDLJhWbPxpZNp/j/zBNcx04W/jQ/1GEoQ7dsBGa/6Nexv0fWdPcTq76j//sP+5i/2d1PpvNoS7tcZydMu0hHKbVfF5uNvP16n7hv2m052CvG9hzEGEYRRhhqTie9/dVzRTyygGrMH72PtRGsTnHabndzh6i11LARm1ReqM3lsPj+rn+L+BQAAb2KtKmC+ywru6jQZEGNM8034oeUyFBcxPGdMJLjz5dBBhNwWvInW3mYUDCXNHBxm1hRWObwQBVHoy0CEYaWgWr14Gz3bg0JhkcggnWGiaW8VOWfI3vj+X9YhZp0oChsJXC3U3DN8ogAwEZCI7B09MiUmEGRq4InkRmXPNqu5gvIzcJ+h2GcsrOBd/8bjnblpvIDiU0ROOdJc/gcffxOMAhy8AA8IPvOazdl8g2sY+AE7yjOeo5bGdPZjENN5syapcBJ5AHXz4pwuLAuijwCbQ9symch8HvysBWBd9sD7k0LiILcyS4/yL8EpYRHTqjw0plCxOaORJcu8mCIw+twqQzweub4PVN8Po2OGz8N+upnu8Xa/iGYLTCSsG7cduYNLICGJlgTcQ2/7hef4naTqB5FJ2iafOErnrK2pdtTxknnGacd/gYD9kUele+0eNTLAj2U3AuvR6eZTmLvLmegHiJG9um3c6KIwZgAmvOA2EGbU+owVzQnJ7m87uP36MlxEQjzNmla3e3msdNNWzK+a6mabyAGhhVSM55zOfruBW0RdZZzz/PFqvY2xfQJCa70IMdpc/l/Mti9VA3j+cRYGOzNb2tyck4hZORmxCBSdwDMOCche4b0tOxgNbKTY49E2pOQt1xS958vVyW8+jNhQTdt5ekdrakIycFBs9e1MexINvCmK/gxTdt6wdPs2qxWddjUFaz7bqKXwb2hI3Hd9zwLsvepAtiQHbe1S2rWTyOBVz0QkQuMnb+NSxaPYAeT+Sc55rb0LmKfEYOOsAuRvN1vdWM4wzoYSe7zRY7jSyDp8Xcfz8TuHdoRZKdBlUdL27RWjKBHWCHvFpsyyoOU+1Ff3ubn4RAg43X6mkXu3jguHQTDciMM1/bmlwpoK9mY+WodXuZgD6UDZctj+3iMRJeTKAP5czlvpzXm5VlNPBFBg2WlQk/qgv3OMDa7NUsTfwW7CcAA2oaQrKw+7cl0U38FkInHQI5EwK5EJLpfLf/DoGcCoFc2KGZAHuYnFXdYvO0nH1vzbUpXLlydgieqxl+f3u4E1hteFvNmV75+LGM1j4wfOGlp5ztu8bUojWdQKvhTM81p5edKZwAnO917akVBwYa3IwvV/Pq+9O2vH+abT9v4tkLTSjs9mUwD9nPclNPp1UEQWSAZcHps2lfv86XMo66dAF7lIWOsAO7Y/RUrb8u7mPPaq+dB2sJy2Q9u1t/W5XV5vPiKV4JYHiUcVO7br9rzqywBVxh2VH9n+dZDGMo6Fpy1jqquXB32MM3hxINNyvrljYLD3ZVEzgrDLcEuXbcmAkomZ2NlkPfqEH3mHdwym11AHx5uIAHj2bYWKL8WsYgGJAbvOCUFW8bk54hWk9Y3dnmpGfIYUzN7gRce8ozwJnNhSLl10cCjSygAifsFI4+hg49egY9esAXdutTgHPVNCxCAQnXAYvWAeDVAZXQJixdWWgVsAxbi+D/CPGDMQGMCxiEydnh+8uFgOFr4fA9wCAwjT99/CsechjHsXPn0xJD0XDbwK5An+rof/0tNnPYRx0go4CgCzYC9awYBBZ6nDD8Ysq5zk/r6nEW230G4S92M+MbbuMVOQemw+5hfMt/rWtfX8VbD+hlFTf8D+UqDpsldPKKjVwfyvXTeoH8BGgZYK6CF7x+rhZRczBSYaKwYP/D4lPca/iyLDr4sNzGzeA+0V4X4+ci6xpt+7uPi9Us3uhIiO0oxVnHQ1UH3GV1t/08Q54drqs523nQ/G5d3RHro4J8OIv5XC7iGQe3qEpwzWKkBLpzIblQoA7xHyLrAi4hZIZC6k7tnGMR8hLT4ArD7lXLkJdQwRWGXKA2wRWGDIMOnHVIIpmgYVui0zjHkKAIntSwK6t7GXJpg9stFhJ0zemlDahNq07x1NIGFxhWedvyMfayMBsQkC4lw7LEAoP/fCpRig2avuAmzj83sWPVEKHiRsw2ove3YLKzgETUmtjfAlNkMREUjhu4u9lt9vy/YZ0JdpRzb/VlEWOcEu5aFLvtXcbrSg7m35QbgratCgjTi12+go3Bl2VsbFOIRu38ZR7sJ2TI7DUETTQTYpewedGhlQ5zUIc5qLPQKmRddMhMmmCZJuQhTchDmixMYXbIl3VIR3hduBtiMy27tozLhSAbG1ctF/N6ION1FgJ7KmS3VcgKqWBfKmN7tlhFKRgwKYIrZKMG25Z0ZQq6Ms4J2Na0J4PT2rBmWTenHBlMUvMvvb2r97bb9XwdK0JARRguzqqbd2y2IXzAT0TIot7w14P4gPhAj8xudZaLr/Xo12t65JiBUQTTZ9H3PQdSlRqqkjeEwINWKEwWZfyQBCaUWiGEwU6QGDWBmz02F7hcz2dxrj0Dr8xmuF2zxTZGqkHDKetFvleLOUKKDXTdnJ4e9dc4WoRbAsXZx+Os+nK//hb5LAiPsTlW27DcPtX7KjLcENAwJOszCS7kWiwg5CczTsFd7DgwFKajJbt16uLcXvYFTKtJ1rcSTAle0FtKFo9yFSmthL2EDkuyeMq+MY4b7F3cYGKxxrdj8LioXwWNsYQAlyz6e0FU1kBUUbLZTseitR+QENRSbJZw35h8CRgCK9bh7pkQLwHXccXiq46FxVVjVcK4UOn+xuRLRNt1xXmvPRPiJTQMKTTnNzuncwZehd1BDphnBnSF3dG2+OBBibbnvHF6Lk2Q1XIjUDuSBf8ILpT3gDFKxmoaASMRihT2DWxqzLYmF3SIRbM7LduaXsph+QibiLbNqUUcek1WEQsMQUXIM99j24zuM0wHFaw5RgyIeZHDYgZ+3XRsiJePfFR3J7zwGCqxJ8uBeNY9rVGUAHE4xS7TTyr253BRYHHKxycdy4LlY4odoCd9R6xjcHqxwdMjxg1gsK34UX3exGCVgDtQyQ6mo4jGBebl/QwUAUySu0LYUGWtipA2noadaNih6VDSrEORqw5FrjoUueqQANYB5zehstCosG0NCLUJu17D+slVuf22rr5QyQmI+E3Y0fi05bJT0DOxGH3dnq0OgUCSMJz6aw492S1ouCLkLgRb+7Bab6ndOEQ32NB2tfkUZw5gECRYqHz1/PgxTqjqKCfVGBNb5u3b04AW3Kt1y+9ac+HmnfO264//jGMXuMSyOd31A5q9MFxSrKyHB8JhTKK1hLPZ9QNyh9AJszrCxVfQODNueq0rJvkDJ1cozpUTziTX28+okmkCI+OAahs2CUwVMcEusOGx3T2VFco8SpiOUezLP60Qngs3p4Ib56f1/XyG4pMJ9LEsovi03tRB1nx9H+cFIO7Bjk+1/rRYoj0irCTobse5QDjELMTR8EDlolB6ADhFKP4WLHLRMKNCHnhSQ7BwCWJwX/+7iGup4K5c9I0MHzrB7LVgQbmGDRU6wRxwX/OeBQJCz8HbCja/2DClAjIBLVWwAAxZQgNPvUkRCvzY8xBPzx/rDcXM14mutvWjb7NqhWqEBPQTgh+mPa8+ABJ6WMFOpz0/ZNZwpEO4I/hpuedTj/Tq03r+jABAWPnOJisgGwq2msB5ygaMBBdiGzeBCVc23gW8yLgeFtgatk70f54X8y+4SFJCO1Ls1rYq5+vqfjn7WMauHfosxR7UqMoHNIngRohFauy73j8vayOd3f/zebO1DxFQDxXKVsUR3gT6S7XL+4Y0UhHSSOHIpg7VvzrMNB1a6RAi2lsPm6A7tMp3aa3dWZtQ9BTSxmZ3YjXk7QyL323K1aZ2R1/jhWcCPSOrwM3ndbW9ayNGMG43bNy+WTysZjgkgJX5YZsiwl5E7c40TcNATcJAhYJGLcNAhb2IDnsRnYVWQSm62OXOQ5otFMeaXSlZOABo2ArHzeLxaVkyJ0dhzStbYLVZP6O8KXQIki0U2TzN5mjHAr1b03E2qHPNSTQG6N+wC6xrTrkzBROxho3sXHtqXY1K1NnG63oFjNevCYwv2GNIm+06rnCJTqIGi2DPxbjm5KDBU4zswuSa04MGKy1YTMS1pwYtCm3ZxlVpRbdPJYO+s2Vp7QJgHRV3NPECG4379vQeEZZh8q8etSf2iGDNYlMqm69oTwB3Eqza0OFreN6UzU5sP66Wd/O7+7vV0/JuWd4/IHOFTCSLaCMuDwgVgOUikg33dkyYnkSnmbj5HjNpdQQmW9hpG3hs2UGBMSibbsBsWp2BQSI7l/ZcmL7ALS67DCIura5ALbMzc8dkM2NHBr4TW1fUZoQ7BEsRJRtrQj5Mf6Dl6T7L2/FpdQfurNlwtWGzYicTDNskW+GF2bQ6A484sZuVPRdmZOBUYNchxKVlN3AisGWXjsmqw8nA45qSBc4wG9yZPDp80jkTVrybgUCIZOFUxKXVFWi+7FHhHRPW0cAoVbK4ZItPqztR8X2nrlcdrgZuI6XpNN8V72tgaYlkbwLZc+GdDdz+SRY5JTi1ugTN2PSaMe9uCmiCLMzYZtTqEPTH7OG/wId3OEVUmjqYT6s70IuypV2ADdMbOCvYM0CYTaszcE6wh1K35V/bu/VqGZeJwx5oNlW2a0tG0PBUOAs7WRZYeoRms4PYNKSjb7hp5dePhgUVgMM4krXzz4sNQF7irWKUxmOn3Oc6hL9DWA3MsEzYofctyeP4cL/HXmPiGMRgI8T2OuXet+5AkXDhV/wEcq2JsycwrlK8xbvm9HFMmOZhq6Q9A0rfUVq5szWRtYehpWILy7aLT+hIBxTKnkywgNy/1isE6EsYoavd4V+2rH7PhbpxCPafX8obFutPn7D24TKuWfA9MEDn3eAo8D5z/aXE4C+0VxbUbBrGx2dhpadgDy9vq9minUaGZygkW51St11tZvOWX4hqf73SDIskASakh4WX4PD2s2dC+0roLvjgoM2lVQIFkwOGn8R7TtREhKbIWuK39Wy7LGeb7ayqZtHaAdwQ+yr4ekBYurM7Ie//DffThQOJoexCBGhRhOJ+EY5TiHC3mCh2p/BCHUc4bCDCGUoZcGMZ7mhSAQVVAQpW7PYQHUuDu6bdJVAsAPN1tlzc+xxNqxgqupOEb/8cj2NUu9SMY/N6Aa0NlxOEcxhid58hezqmBUlHdRy7Y77cHHLNidmjYGrNsHWUvgqSnDcQIWR9iGtP2XnkvrnG68W8vFutt6hCCHogttbsaxWfo4LYkmJD7m+zuJgBegfJZsTqVndfMegN9wqser6VH+NuQitS7HbbNqMqvODIsEdK6sbxTVmR02FD1X8tnuxFDPHKDxcvugToz1cvnhZP5XKxqqlu//zPf/4XO+sY5xWlAQA="; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css new file mode 100644 index 0000000..108428c --- /dev/null +++ b/docs/assets/style.css @@ -0,0 +1,1383 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: var(--light-color-ts-type-alias); + --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: var(--dark-color-ts-type-alias); + --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 > a, +h2 > a, +h3 > a, +h4 > a, +h5 > a, +h6 > a { + text-decoration: none; + color: var(--color-text); +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +.uppercase { + text-transform: uppercase; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1700px; + padding: 0 2rem; +} + +/* Footer */ +.tsd-generator { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} + +.tsd-generator > p { + margin-top: 0; + margin-bottom: 0; + padding: 0 1rem; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} +pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; +} +pre:hover > button, +pre > button.visible { + opacity: 1; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h4, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} +.tsd-typography table { + border-collapse: collapse; + border: none; +} +.tsd-typography td, +.tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); +} +.tsd-typography thead, +.tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus + svg { + transform: scale(0.95); +} +.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { + transform: scale(1); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.tsd-theme-toggle { + padding-top: 0.75rem; +} +.tsd-theme-toggle > h4 { + display: inline; + vertical-align: middle; + margin-right: 0.75rem; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: relative; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.tsd-navigation.settings { + margin: 1rem 0; +} +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.5rem); +} +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: inline-flex; + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); +} +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li, +.tsd-page-navigation li { + padding: 0; + max-width: 100%; +} +.tsd-nested-navigation { + margin-left: 3rem; +} +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; +} +.tsd-small-nested-navigation { + margin-left: 1.5rem; +} +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; +} + +.tsd-nested-navigation > li > a, +.tsd-nested-navigation > li > span { + width: calc(100% - 1.75rem - 0.5rem); +} + +.tsd-page-navigation ul { + padding-left: 1.75rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} +.tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ +} +.tsd-accordion-summary, +.tsd-accordion-summary a { + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + + cursor: pointer; +} +.tsd-accordion-summary a { + width: calc(100% - 1.5rem); +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-index-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 4rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + background-color: var(--color-background); + line-height: initial; + padding: 4px; +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current:not(.no-results), +#tsd-search .results li:hover:not(.no-results) { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through !important; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +.tsd-kind-project { + color: var(--color-ts-project); +} +.tsd-kind-module { + color: var(--color-ts-module); +} +.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-kind-enum-member { + color: var(--color-ts-enum-member); +} +.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-kind-constructor { + color: var(--color-ts-constructor); +} +.tsd-kind-property { + color: var(--color-ts-property); +} +.tsd-kind-method { + color: var(--color-ts-method); +} +.tsd-kind-call-signature { + color: var(--color-ts-call-signature); +} +.tsd-kind-index-signature { + color: var(--color-ts-index-signature); +} +.tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); +} +.tsd-kind-parameter { + color: var(--color-ts-parameter); +} +.tsd-kind-type-literal { + color: var(--color-ts-type-literal); +} +.tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); +} +.tsd-kind-accessor { + color: var(--color-ts-accessor); +} +.tsd-kind-get-signature { + color: var(--color-ts-get-signature); +} +.tsd-kind-set-signature { + color: var(--color-ts-set-signature); +} +.tsd-kind-type-alias { + color: var(--color-ts-type-alias); +} + +/* if we have a kind icon, don't color the text by kind */ +.tsd-kind-icon ~ span { + color: var(--color-text); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} + +/* mobile */ +@media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +/* one sidebar */ +@media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } +} +@media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } +} + +/* two sidebars */ +@media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/docs/classes/ValidationError.html b/docs/classes/ValidationError.html new file mode 100644 index 0000000..9e88b0d --- /dev/null +++ b/docs/classes/ValidationError.html @@ -0,0 +1,119 @@ +ValidationError | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Class ValidationError

+
+

Hierarchy

+
    +
  • Error +
      +
    • ValidationError
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
name +
+
+

Constructors

+
+

constructor

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      Optional message: string
    +

    Returns ValidationError

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      Optional message: string
      • +
    • +
      Optional options: ErrorOptions
    +

    Returns ValidationError

+
+

Properties

+
+

name

+
name: "ValidationError" = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/docs/enums/ConditionComparisonOperator.html b/docs/enums/ConditionComparisonOperator.html new file mode 100644 index 0000000..9da79bd --- /dev/null +++ b/docs/enums/ConditionComparisonOperator.html @@ -0,0 +1,113 @@ +ConditionComparisonOperator | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Enumeration ConditionComparisonOperator

+
+
+
+ +
+
+

Enumeration Members

+
EQUAL +GREATER_THAN +GREATER_THAN_OR_EQUAL +LESS_THAN +LESS_THAN_OR_EQUAL +NOT_EQUAL +
+
+

Enumeration Members

+
+

EQUAL

+
EQUAL: "EQUAL"
+
+

GREATER_THAN

+
GREATER_THAN: "GREATER_THAN"
+
+

GREATER_THAN_OR_EQUAL

+
GREATER_THAN_OR_EQUAL: "GREATER_THAN_OR_EQUAL"
+
+

LESS_THAN

+
LESS_THAN: "LESS_THAN"
+
+

LESS_THAN_OR_EQUAL

+
LESS_THAN_OR_EQUAL: "LESS_THAN_OR_EQUAL"
+
+

NOT_EQUAL

+
NOT_EQUAL: "NOT_EQUAL"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/docs/enums/ConditionType.html b/docs/enums/ConditionType.html new file mode 100644 index 0000000..d1e71f0 --- /dev/null +++ b/docs/enums/ConditionType.html @@ -0,0 +1,127 @@ +ConditionType | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Enumeration ConditionType

+
+
+
+ +
+
+

Enumeration Members

+
AND +COLLECT +EOA_OWNERSHIP +ERC20_OWNERSHIP +FOLLOW +NFT_OWNERSHIP +OR +PROFILE_OWNERSHIP +
+
+

Enumeration Members

+
+

AND

+
AND: "AND"
+
+

COLLECT

+
COLLECT: "COLLECT"
+
+

EOA_OWNERSHIP

+
EOA_OWNERSHIP: "EOA_OWNERSHIP"
+
+

ERC20_OWNERSHIP

+
ERC20_OWNERSHIP: "ERC20_OWNERSHIP"
+
+

FOLLOW

+
FOLLOW: "FOLLOW"
+
+

NFT_OWNERSHIP

+
NFT_OWNERSHIP: "NFT_OWNERSHIP"
+
+

OR

+
OR: "OR"
+
+

PROFILE_OWNERSHIP

+
PROFILE_OWNERSHIP: "PROFILE_OWNERSHIP"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/docs/enums/EncryptionProvider.html b/docs/enums/EncryptionProvider.html new file mode 100644 index 0000000..2f321f2 --- /dev/null +++ b/docs/enums/EncryptionProvider.html @@ -0,0 +1,78 @@ +EncryptionProvider | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Enumeration EncryptionProvider

+
+
+
+ +
+
+

Enumeration Members

+
LIT_PROTOCOL +
+
+

Enumeration Members

+
+

LIT_PROTOCOL

+
LIT_PROTOCOL: "LIT_PROTOCOL"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/docs/enums/MarketplaceMetadataAttributeDisplayType.html b/docs/enums/MarketplaceMetadataAttributeDisplayType.html new file mode 100644 index 0000000..f62a063 --- /dev/null +++ b/docs/enums/MarketplaceMetadataAttributeDisplayType.html @@ -0,0 +1,92 @@ +MarketplaceMetadataAttributeDisplayType | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Enumeration MarketplaceMetadataAttributeDisplayType

+
+
+
+ +
+
+

Enumeration Members

+
DATE +NUMBER +STRING +
+
+

Enumeration Members

+
+

DATE

+
DATE: "date"
+
+

NUMBER

+
NUMBER: "number"
+
+

STRING

+
STRING: "string"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/docs/enums/MediaAudioKind.html b/docs/enums/MediaAudioKind.html new file mode 100644 index 0000000..111db13 --- /dev/null +++ b/docs/enums/MediaAudioKind.html @@ -0,0 +1,113 @@ +MediaAudioKind | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Enumeration MediaAudioKind

+
+
+
+ +
+
+

Enumeration Members

+
AUDIOBOOK +MUSIC +OTHER +PODCAST +SOUND +VOICE_NOTE +
+
+

Enumeration Members

+
+

AUDIOBOOK

+
AUDIOBOOK: "AUDIOBOOK"
+
+

MUSIC

+
MUSIC: "MUSIC"
+
+

OTHER

+
OTHER: "OTHER"
+
+

PODCAST

+
PODCAST: "PODCAST"
+
+

SOUND

+
SOUND: "SOUND"
+
+

VOICE_NOTE

+
VOICE_NOTE: "VOICE_NOTE"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/docs/enums/MediaAudioMimeType.html b/docs/enums/MediaAudioMimeType.html new file mode 100644 index 0000000..9c7f5e9 --- /dev/null +++ b/docs/enums/MediaAudioMimeType.html @@ -0,0 +1,127 @@ +MediaAudioMimeType | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Enumeration MediaAudioMimeType

+
+
+
+ +
+
+

Enumeration Members

+
AAC +FLAC +MP3 +MP4_AUDIO +OGG_AUDIO +WAV +WAV_VND +WEBM_AUDIO +
+
+

Enumeration Members

+
+

AAC

+
AAC: "audio/aac"
+
+

FLAC

+
FLAC: "audio/flac"
+
+

MP3

+
MP3: "audio/mpeg"
+
+

MP4_AUDIO

+
MP4_AUDIO: "audio/mp4"
+
+

OGG_AUDIO

+
OGG_AUDIO: "audio/ogg"
+
+

WAV

+
WAV: "audio/wav"
+
+

WAV_VND

+
WAV_VND: "audio/vnd.wave"
+
+

WEBM_AUDIO

+
WEBM_AUDIO: "audio/webm"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/docs/enums/MediaImageMimeType.html b/docs/enums/MediaImageMimeType.html new file mode 100644 index 0000000..d9c301f --- /dev/null +++ b/docs/enums/MediaImageMimeType.html @@ -0,0 +1,127 @@ +MediaImageMimeType | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Enumeration MediaImageMimeType

+
+
+
+ +
+
+

Enumeration Members

+
BMP +GIF +HEIC +JPEG +PNG +SVG +TIFF +WEBP +
+
+

Enumeration Members

+
+

BMP

+
BMP: "image/x-ms-bmp"
+
+

GIF

+
GIF: "image/gif"
+
+

HEIC

+
HEIC: "image/heic"
+
+

JPEG

+
JPEG: "image/jpeg"
+
+

PNG

+
PNG: "image/png"
+
+

SVG

+
SVG: "image/svg+xml"
+
+

TIFF

+
TIFF: "image/tiff"
+
+

WEBP

+
WEBP: "image/webp"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/docs/enums/MediaVideoMimeType.html b/docs/enums/MediaVideoMimeType.html new file mode 100644 index 0000000..44b0b6a --- /dev/null +++ b/docs/enums/MediaVideoMimeType.html @@ -0,0 +1,141 @@ +MediaVideoMimeType | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Enumeration MediaVideoMimeType

+
+
+
+ +
+
+

Enumeration Members

+
GLTF +GLTF_BINARY +M4V +MOV +MP4 +MPEG +OGG +OGV +QUICKTIME +WEBM +
+
+

Enumeration Members

+
+

GLTF

+
GLTF: "model/gltf+json"
+
+

GLTF_BINARY

+
GLTF_BINARY: "model/gltf-binary"
+
+

M4V

+
M4V: "video/x-m4v"
+
+

MOV

+
MOV: "video/mov"
+
+

MP4

+
MP4: "video/mp4"
+
+

MPEG

+
MPEG: "video/mpeg"
+
+

OGG

+
OGG: "video/ogg"
+
+

OGV

+
OGV: "video/ogv"
+
+

QUICKTIME

+
QUICKTIME: "video/quicktime"
+
+

WEBM

+
WEBM: "video/webm"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/docs/enums/MetadataAttributeType.html b/docs/enums/MetadataAttributeType.html new file mode 100644 index 0000000..aba0de4 --- /dev/null +++ b/docs/enums/MetadataAttributeType.html @@ -0,0 +1,106 @@ +MetadataAttributeType | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Enumeration MetadataAttributeType

+
+
+
+ +
+
+

Enumeration Members

+
BOOLEAN +DATE +JSON +NUMBER +STRING +
+
+

Enumeration Members

+
+

BOOLEAN

+
BOOLEAN: "Boolean"
+
+

DATE

+
DATE: "Date"
+
+

JSON

+
JSON: "JSON"
+
+

NUMBER

+
NUMBER: "Number"
+
+

STRING

+
STRING: "String"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/docs/enums/MetadataLicenseType.html b/docs/enums/MetadataLicenseType.html new file mode 100644 index 0000000..e59174c --- /dev/null +++ b/docs/enums/MetadataLicenseType.html @@ -0,0 +1,323 @@ +MetadataLicenseType | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Enumeration MetadataLicenseType

+
+
+
+ +
+
+

Enumeration Members

+
CCO +CC_BY +CC_BY_NC +CC_BY_ND +TBNL_C_DTSA_NPL_Ledger +TBNL_C_DTSA_NPL_Legal +TBNL_C_DTSA_PL_Ledger +TBNL_C_DTSA_PL_Legal +TBNL_C_DT_NPL_Ledger +TBNL_C_DT_NPL_Legal +TBNL_C_DT_PL_Ledger +TBNL_C_DT_PL_Legal +TBNL_C_D_NPL_Ledger +TBNL_C_D_NPL_Legal +TBNL_C_D_PL_Ledger +TBNL_C_D_PL_Legal +TBNL_C_ND_NPL_Ledger +TBNL_C_ND_NPL_Legal +TBNL_C_ND_PL_Ledger +TBNL_C_ND_PL_Legal +TBNL_NC_DTSA_NPL_Ledger +TBNL_NC_DTSA_NPL_Legal +TBNL_NC_DTSA_PL_Ledger +TBNL_NC_DTSA_PL_Legal +TBNL_NC_DT_NPL_Ledger +TBNL_NC_DT_NPL_Legal +TBNL_NC_DT_PL_Ledger +TBNL_NC_DT_PL_Legal +TBNL_NC_D_NPL_Ledger +TBNL_NC_D_NPL_Legal +TBNL_NC_D_PL_Ledger +TBNL_NC_D_PL_Legal +TBNL_NC_ND_NPL_Ledger +TBNL_NC_ND_NPL_Legal +TBNL_NC_ND_PL_Ledger +TBNL_NC_ND_PL_Legal +
+
+

Enumeration Members

+
+

CCO

+
CCO: "CCO"
+
+

CC_BY

+
CC_BY: "CC BY"
+
+

CC_BY_NC

+
CC_BY_NC: "CC BY-NC"
+
+

CC_BY_ND

+
CC_BY_ND: "CC BY-ND"
+
+

TBNL_C_DTSA_NPL_Ledger

+
TBNL_C_DTSA_NPL_Ledger: "TBNL-C-DTSA-NPL-Ledger"
+
+

TBNL_C_DTSA_NPL_Legal

+
TBNL_C_DTSA_NPL_Legal: "TBNL-C-DTSA-NPL-Legal"
+
+

TBNL_C_DTSA_PL_Ledger

+
TBNL_C_DTSA_PL_Ledger: "TBNL-C-DTSA-PL-Ledger"
+
+

TBNL_C_DTSA_PL_Legal

+
TBNL_C_DTSA_PL_Legal: "TBNL-C-DTSA-PL-Legal"
+
+

TBNL_C_DT_NPL_Ledger

+
TBNL_C_DT_NPL_Ledger: "TBNL-C-DT-NPL-Ledger"
+
+

TBNL_C_DT_NPL_Legal

+
TBNL_C_DT_NPL_Legal: "TBNL-C-DT-NPL-Legal"
+
+

TBNL_C_DT_PL_Ledger

+
TBNL_C_DT_PL_Ledger: "TBNL-C-DT-PL-Ledger"
+
+

TBNL_C_DT_PL_Legal

+
TBNL_C_DT_PL_Legal: "TBNL-C-DT-PL-Legal"
+
+

TBNL_C_D_NPL_Ledger

+
TBNL_C_D_NPL_Ledger: "TBNL-C-D-NPL-Ledger"
+
+

TBNL_C_D_NPL_Legal

+
TBNL_C_D_NPL_Legal: "TBNL-C-D-NPL-Legal"
+
+

TBNL_C_D_PL_Ledger

+
TBNL_C_D_PL_Ledger: "TBNL-C-D-PL-Ledger"
+
+

TBNL_C_D_PL_Legal

+
TBNL_C_D_PL_Legal: "TBNL-C-D-PL-Legal"
+
+

TBNL_C_ND_NPL_Ledger

+
TBNL_C_ND_NPL_Ledger: "TBNL-C-ND-NPL-Ledger"
+
+

TBNL_C_ND_NPL_Legal

+
TBNL_C_ND_NPL_Legal: "TBNL-C-ND-NPL-Legal"
+
+

TBNL_C_ND_PL_Ledger

+
TBNL_C_ND_PL_Ledger: "TBNL-C-ND-PL-Ledger"
+
+

TBNL_C_ND_PL_Legal

+
TBNL_C_ND_PL_Legal: "TBNL-C-ND-PL-Legal"
+
+

TBNL_NC_DTSA_NPL_Ledger

+
TBNL_NC_DTSA_NPL_Ledger: "TBNL-NC-DTSA-NPL-Ledger"
+
+

TBNL_NC_DTSA_NPL_Legal

+
TBNL_NC_DTSA_NPL_Legal: "TBNL-NC-DTSA-NPL-Legal"
+
+

TBNL_NC_DTSA_PL_Ledger

+
TBNL_NC_DTSA_PL_Ledger: "TBNL-NC-DTSA-PL-Ledger"
+
+

TBNL_NC_DTSA_PL_Legal

+
TBNL_NC_DTSA_PL_Legal: "TBNL-NC-DTSA-PL-Legal"
+
+

TBNL_NC_DT_NPL_Ledger

+
TBNL_NC_DT_NPL_Ledger: "TBNL-NC-DT-NPL-Ledger"
+
+

TBNL_NC_DT_NPL_Legal

+
TBNL_NC_DT_NPL_Legal: "TBNL-NC-DT-NPL-Legal"
+
+

TBNL_NC_DT_PL_Ledger

+
TBNL_NC_DT_PL_Ledger: "TBNL-NC-DT-PL-Ledger"
+
+

TBNL_NC_DT_PL_Legal

+
TBNL_NC_DT_PL_Legal: "TBNL-NC-DT-PL-Legal"
+
+

TBNL_NC_D_NPL_Ledger

+
TBNL_NC_D_NPL_Ledger: "TBNL-NC-D-NPL-Ledger"
+
+

TBNL_NC_D_NPL_Legal

+
TBNL_NC_D_NPL_Legal: "TBNL-NC-D-NPL-Legal"
+
+

TBNL_NC_D_PL_Ledger

+
TBNL_NC_D_PL_Ledger: "TBNL-NC-D-PL-Ledger"
+
+

TBNL_NC_D_PL_Legal

+
TBNL_NC_D_PL_Legal: "TBNL-NC-D-PL-Legal"
+
+

TBNL_NC_ND_NPL_Ledger

+
TBNL_NC_ND_NPL_Ledger: "TBNL-NC-ND-NPL-Ledger"
+
+

TBNL_NC_ND_NPL_Legal

+
TBNL_NC_ND_NPL_Legal: "TBNL-NC-ND-NPL-Legal"
+
+

TBNL_NC_ND_PL_Ledger

+
TBNL_NC_ND_PL_Ledger: "TBNL-NC-ND-PL-Ledger"
+
+

TBNL_NC_ND_PL_Legal

+
TBNL_NC_ND_PL_Legal: "TBNL-NC-ND-PL-Legal"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/docs/enums/MirrorSchemaId.html b/docs/enums/MirrorSchemaId.html new file mode 100644 index 0000000..b5e6f02 --- /dev/null +++ b/docs/enums/MirrorSchemaId.html @@ -0,0 +1,78 @@ +MirrorSchemaId | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Enumeration MirrorSchemaId

+
+
+
+ +
+
+

Enumeration Members

+
LATEST +
+
+

Enumeration Members

+
+

LATEST

+
LATEST: "https://json-schemas.lens.dev/publications/mirror/1.0.0.json"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/docs/enums/NftContractType.html b/docs/enums/NftContractType.html new file mode 100644 index 0000000..bc16197 --- /dev/null +++ b/docs/enums/NftContractType.html @@ -0,0 +1,85 @@ +NftContractType | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Enumeration NftContractType

+
+
+
+ +
+
+

Enumeration Members

+
ERC1155 +ERC721 +
+
+

Enumeration Members

+
+

ERC1155

+
ERC1155: "ERC1155"
+
+

ERC721

+
ERC721: "ERC721"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/docs/enums/ProfileSchemaId.html b/docs/enums/ProfileSchemaId.html new file mode 100644 index 0000000..1892576 --- /dev/null +++ b/docs/enums/ProfileSchemaId.html @@ -0,0 +1,78 @@ +ProfileSchemaId | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Enumeration ProfileSchemaId

+
+
+
+ +
+
+

Enumeration Members

+
LATEST +
+
+

Enumeration Members

+
+

LATEST

+
LATEST: "https://json-schemas.lens.dev/profile/2.0.0.json"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/docs/enums/PublicationContentWarning.html b/docs/enums/PublicationContentWarning.html new file mode 100644 index 0000000..3c0b76d --- /dev/null +++ b/docs/enums/PublicationContentWarning.html @@ -0,0 +1,92 @@ +PublicationContentWarning | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Enumeration PublicationContentWarning

+
+
+
+ +
+
+

Enumeration Members

+
NSFW +SENSITIVE +SPOILER +
+
+

Enumeration Members

+
+

NSFW

+
NSFW: "NSFW"
+
+

SENSITIVE

+
SENSITIVE: "SENSITIVE"
+
+

SPOILER

+
SPOILER: "SPOILER"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/docs/enums/PublicationMainFocus.html b/docs/enums/PublicationMainFocus.html new file mode 100644 index 0000000..0b07492 --- /dev/null +++ b/docs/enums/PublicationMainFocus.html @@ -0,0 +1,183 @@ +PublicationMainFocus | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Enumeration PublicationMainFocus

+
+
+
+ +
+
+

Enumeration Members

+
ARTICLE +AUDIO +CHECKING_IN +EMBED +EVENT +IMAGE +LINK +LIVESTREAM +MINT +SHORT_VIDEO +SPACE +STORY +TEXT_ONLY +THREE_D +TRANSACTION +VIDEO +
+
+

Enumeration Members

+
+

ARTICLE

+
ARTICLE: "ARTICLE"
+
+

AUDIO

+
AUDIO: "AUDIO"
+
+

CHECKING_IN

+
CHECKING_IN: "CHECKING_IN"
+
+

EMBED

+
EMBED: "EMBED"
+
+

EVENT

+
EVENT: "EVENT"
+
+

IMAGE

+
IMAGE: "IMAGE"
+
+

LINK

+
LINK: "LINK"
+
+

LIVESTREAM

+
LIVESTREAM: "LIVESTREAM"
+
+

MINT

+
MINT: "MINT"
+
+

SHORT_VIDEO

+
SHORT_VIDEO: "SHORT_VIDEO"
+
+

SPACE

+
SPACE: "SPACE"
+
+

STORY

+
STORY: "STORY"
+
+

TEXT_ONLY

+
TEXT_ONLY: "TEXT_ONLY"
+
+

THREE_D

+
THREE_D: "3D"
+
+

TRANSACTION

+
TRANSACTION: "TRANSACTION"
+
+

VIDEO

+
VIDEO: "VIDEO"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/docs/enums/PublicationSchemaId.html b/docs/enums/PublicationSchemaId.html new file mode 100644 index 0000000..37e5eb8 --- /dev/null +++ b/docs/enums/PublicationSchemaId.html @@ -0,0 +1,176 @@ +PublicationSchemaId | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Enumeration PublicationSchemaId

+
+
+
+ +
+
+

Enumeration Members

+
ARTICLE_LATEST +AUDIO_LATEST +CHECKING_IN_LATEST +EMBED_LATEST +EVENT_LATEST +IMAGE_LATEST +LINK_LATEST +LIVESTREAM_LATEST +MINT_LATEST +SPACE_LATEST +STORY_LATEST +TEXT_ONLY_LATEST +THREE_D_LATEST +TRANSACTION_LATEST +VIDEO_LATEST +
+
+

Enumeration Members

+
+

ARTICLE_LATEST

+
ARTICLE_LATEST: "https://json-schemas.lens.dev/publications/article/3.0.0.json"
+
+

AUDIO_LATEST

+
AUDIO_LATEST: "https://json-schemas.lens.dev/publications/audio/3.0.0.json"
+
+

CHECKING_IN_LATEST

+
CHECKING_IN_LATEST: "https://json-schemas.lens.dev/publications/checking-in/3.0.0.json"
+
+

EMBED_LATEST

+
EMBED_LATEST: "https://json-schemas.lens.dev/publications/embed/3.0.0.json"
+
+

EVENT_LATEST

+
EVENT_LATEST: "https://json-schemas.lens.dev/publications/event/3.0.0.json"
+
+

IMAGE_LATEST

+
IMAGE_LATEST: "https://json-schemas.lens.dev/publications/image/3.0.0.json"
+
+

LINK_LATEST

+
LINK_LATEST: "https://json-schemas.lens.dev/publications/link/3.0.0.json"
+
+

LIVESTREAM_LATEST

+
LIVESTREAM_LATEST: "https://json-schemas.lens.dev/publications/livestream/3.0.0.json"
+
+

MINT_LATEST

+
MINT_LATEST: "https://json-schemas.lens.dev/publications/mint/3.0.0.json"
+
+

SPACE_LATEST

+
SPACE_LATEST: "https://json-schemas.lens.dev/publications/space/3.0.0.json"
+
+

STORY_LATEST

+
STORY_LATEST: "https://json-schemas.lens.dev/publications/story/3.0.0.json"
+
+

TEXT_ONLY_LATEST

+
TEXT_ONLY_LATEST: "https://json-schemas.lens.dev/publications/text-only/3.0.0.json"
+
+

THREE_D_LATEST

+
THREE_D_LATEST: "https://json-schemas.lens.dev/publications/3d/3.0.0.json"
+
+

TRANSACTION_LATEST

+
TRANSACTION_LATEST: "https://json-schemas.lens.dev/publications/transaction/3.0.0.json"
+
+

VIDEO_LATEST

+
VIDEO_LATEST: "https://json-schemas.lens.dev/publications/video/3.0.0.json"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/docs/enums/ThreeDFormat.html b/docs/enums/ThreeDFormat.html new file mode 100644 index 0000000..ce1471d --- /dev/null +++ b/docs/enums/ThreeDFormat.html @@ -0,0 +1,99 @@ +ThreeDFormat | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Enumeration ThreeDFormat

+
+
+
+ +
+
+

Enumeration Members

+
fbx +gLTF +obj +vrm +
+
+

Enumeration Members

+
+

fbx

+
fbx: "FBX"
+
+

gLTF

+
gLTF: "gLTF/GLB"
+
+

obj

+
obj: "OBJ"
+
+

vrm

+
vrm: "VRM"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/docs/enums/TransactionMetadataType.html b/docs/enums/TransactionMetadataType.html new file mode 100644 index 0000000..261ed4b --- /dev/null +++ b/docs/enums/TransactionMetadataType.html @@ -0,0 +1,92 @@ +TransactionMetadataType | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Enumeration TransactionMetadataType

+
+
+
+ +
+
+

Enumeration Members

+
ERC20 +ERC721 +OTHER +
+
+

Enumeration Members

+
+

ERC20

+
ERC20: "ERC20"
+
+

ERC721

+
ERC721: "ERC721"
+
+

OTHER

+
OTHER: "OTHER"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/docs/functions/andCondition-1.html b/docs/functions/andCondition-1.html new file mode 100644 index 0000000..6c0e2b9 --- /dev/null +++ b/docs/functions/andCondition-1.html @@ -0,0 +1,72 @@ +andCondition | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function andCondition

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/article.html b/docs/functions/article.html new file mode 100644 index 0000000..7978b88 --- /dev/null +++ b/docs/functions/article.html @@ -0,0 +1,139 @@ +article | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function article

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/asset-2.html b/docs/functions/asset-2.html new file mode 100644 index 0000000..4958b44 --- /dev/null +++ b/docs/functions/asset-2.html @@ -0,0 +1,77 @@ +asset | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function asset

+
+
    + +
  • +

    Creates an Asset.

    +
    +
    +

    Parameters

    +
      +
    • +
      contract: {
          address: string & {
              __type__: "EvmAddress";
          };
          chainId: number & {
              __type__: "ChainId";
          };
      }
      +
        +
      • +
        address: string & {
            __type__: "EvmAddress";
        }
        • +
      • +
        chainId: number & {
            __type__: "ChainId";
        }
      • +
    • +
      decimals: number
    +

    Returns Asset

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/audio.html b/docs/functions/audio.html new file mode 100644 index 0000000..093acd7 --- /dev/null +++ b/docs/functions/audio.html @@ -0,0 +1,166 @@ +audio | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function audio

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/checkingIn.html b/docs/functions/checkingIn.html new file mode 100644 index 0000000..bf0c936 --- /dev/null +++ b/docs/functions/checkingIn.html @@ -0,0 +1,156 @@ +checkingIn | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function checkingIn

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/embed.html b/docs/functions/embed.html new file mode 100644 index 0000000..5125b5c --- /dev/null +++ b/docs/functions/embed.html @@ -0,0 +1,139 @@ +embed | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function embed

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/event.html b/docs/functions/event.html new file mode 100644 index 0000000..b32d0db --- /dev/null +++ b/docs/functions/event.html @@ -0,0 +1,169 @@ +event | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function event

+
+
    + +
  • +

    Creates a valid EventMetadata.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          address?: {
              country: string;
              formatted?: string;
              locality: string;
              postalCode?: string;
              region?: string;
              streetAddress?: string;
          };
          appId?: string;
          attachments?: ({
              artist?: string;
              attributes?: (({ value: "true" | "false"; type: MetadataAttributeType.BOOLEAN; key: string; }) | ({ value: string; type: MetadataAttributeType.DATE; key: string; }) | ({ value: string; type: MetadataAttributeType.NUMBER; key: string; }) | ({ value: string; type: MetadataAttributeType.STRING; key: string; }) | ({ value: string; type: MetadataAttributeType.JSON; key: string; }))[];
              cover?: string;
              credits?: string;
              duration?: number;
              genre?: string;
              item: string;
              kind?: MUSIC | PODCAST | AUDIOBOOK | VOICE_NOTE | SOUND | OTHER;
              license?: CCO | CC_BY | CC_BY_ND | CC_BY_NC | TBNL_C_D_PL_Legal | TBNL_C_DT_PL_Legal | TBNL_C_ND_PL_Legal | TBNL_C_D_NPL_Legal | TBNL_C_DT_NPL_Legal | TBNL_C_DTSA_PL_Legal | TBNL_C_DTSA_NPL_Legal | TBNL_C_ND_NPL_Legal | TBNL_C_D_PL_Ledger | TBNL_C_DT_PL_Ledger | TBNL_C_ND_PL_Ledger | TBNL_C_D_NPL_Ledger | TBNL_C_DT_NPL_Ledger | TBNL_C_DTSA_PL_Ledger | TBNL_C_DTSA_NPL_Ledger | TBNL_C_ND_NPL_Ledger | TBNL_NC_D_PL_Legal | TBNL_NC_DT_PL_Legal | TBNL_NC_ND_PL_Legal | TBNL_NC_D_NPL_Legal | TBNL_NC_DT_NPL_Legal | TBNL_NC_DTSA_PL_Legal | TBNL_NC_DTSA_NPL_Legal | TBNL_NC_ND_NPL_Legal | TBNL_NC_D_PL_Ledger | TBNL_NC_DT_PL_Ledger | TBNL_NC_ND_PL_Ledger | TBNL_NC_D_NPL_Ledger | TBNL_NC_DT_NPL_Ledger | TBNL_NC_DTSA_PL_Ledger | TBNL_NC_DTSA_NPL_Ledger | TBNL_NC_ND_NPL_Ledger;
              lyrics?: string;
              recordLabel?: string;
              type: MediaAudioMimeType;
          } | {
              altTag?: string;
              attributes?: (({ value: "true" | "false"; type: MetadataAttributeType.BOOLEAN; key: string; }) | ({ value: string; type: MetadataAttributeType.DATE; key: string; }) | ({ value: string; type: MetadataAttributeType.NUMBER; key: string; }) | ({ value: string; type: MetadataAttributeType.STRING; key: string; }) | ({ value: string; type: MetadataAttributeType.JSON; key: string; }))[];
              item: string;
              license?: CCO | CC_BY | CC_BY_ND | CC_BY_NC | TBNL_C_D_PL_Legal | TBNL_C_DT_PL_Legal | TBNL_C_ND_PL_Legal | TBNL_C_D_NPL_Legal | TBNL_C_DT_NPL_Legal | TBNL_C_DTSA_PL_Legal | TBNL_C_DTSA_NPL_Legal | TBNL_C_ND_NPL_Legal | TBNL_C_D_PL_Ledger | TBNL_C_DT_PL_Ledger | TBNL_C_ND_PL_Ledger | TBNL_C_D_NPL_Ledger | TBNL_C_DT_NPL_Ledger | TBNL_C_DTSA_PL_Ledger | TBNL_C_DTSA_NPL_Ledger | TBNL_C_ND_NPL_Ledger | TBNL_NC_D_PL_Legal | TBNL_NC_DT_PL_Legal | TBNL_NC_ND_PL_Legal | TBNL_NC_D_NPL_Legal | TBNL_NC_DT_NPL_Legal | TBNL_NC_DTSA_PL_Legal | TBNL_NC_DTSA_NPL_Legal | TBNL_NC_ND_NPL_Legal | TBNL_NC_D_PL_Ledger | TBNL_NC_DT_PL_Ledger | TBNL_NC_ND_PL_Ledger | TBNL_NC_D_NPL_Ledger | TBNL_NC_DT_NPL_Ledger | TBNL_NC_DTSA_PL_Ledger | TBNL_NC_DTSA_NPL_Ledger | TBNL_NC_ND_NPL_Ledger;
              type: MediaImageMimeType;
          } | {
              altTag?: string;
              attributes?: (({ value: "true" | "false"; type: MetadataAttributeType.BOOLEAN; key: string; }) | ({ value: string; type: MetadataAttributeType.DATE; key: string; }) | ({ value: string; type: MetadataAttributeType.NUMBER; key: string; }) | ({ value: string; type: MetadataAttributeType.STRING; key: string; }) | ({ value: string; type: MetadataAttributeType.JSON; key: string; }))[];
              cover?: string;
              duration?: number;
              item: string;
              license?: CCO | CC_BY | CC_BY_ND | CC_BY_NC | TBNL_C_D_PL_Legal | TBNL_C_DT_PL_Legal | TBNL_C_ND_PL_Legal | TBNL_C_D_NPL_Legal | TBNL_C_DT_NPL_Legal | TBNL_C_DTSA_PL_Legal | TBNL_C_DTSA_NPL_Legal | TBNL_C_ND_NPL_Legal | TBNL_C_D_PL_Ledger | TBNL_C_DT_PL_Ledger | TBNL_C_ND_PL_Ledger | TBNL_C_D_NPL_Ledger | TBNL_C_DT_NPL_Ledger | TBNL_C_DTSA_PL_Ledger | TBNL_C_DTSA_NPL_Ledger | TBNL_C_ND_NPL_Ledger | TBNL_NC_D_PL_Legal | TBNL_NC_DT_PL_Legal | TBNL_NC_ND_PL_Legal | TBNL_NC_D_NPL_Legal | TBNL_NC_DT_NPL_Legal | TBNL_NC_DTSA_PL_Legal | TBNL_NC_DTSA_NPL_Legal | TBNL_NC_ND_NPL_Legal | TBNL_NC_D_PL_Ledger | TBNL_NC_DT_PL_Ledger | TBNL_NC_ND_PL_Ledger | TBNL_NC_D_NPL_Ledger | TBNL_NC_DT_NPL_Ledger | TBNL_NC_DTSA_PL_Ledger | TBNL_NC_DTSA_NPL_Ledger | TBNL_NC_ND_NPL_Ledger;
              type: MediaVideoMimeType;
          })[];
          attributes?: ({
              key: string;
              type: BOOLEAN;
              value: "true" | "false";
          } | {
              key: string;
              type: DATE;
              value: string;
          } | {
              key: string;
              type: NUMBER;
              value: string;
          } | {
              key: string;
              type: STRING;
              value: string;
          } | {
              key: string;
              type: JSON;
              value: string;
          })[];
          content?: string;
          contentWarning?: NSFW | SENSITIVE | SPOILER;
          encryptedWith?: {
              accessCondition: { type: ConditionType.OR; criteria: [{ type: ConditionType.NFT_OWNERSHIP; contract: { chainId: number; address: string; }; contractType: NftContractType; tokenIds?: string[] | undefined; } | ... 6 more ... | { ...; }, { ...; } | ... 6 more ... | { ...; }, ...({ ...; } | ... 6 more ... | { ...; })[]]; };
              encryptedPaths: string[];
              encryptionKey: string;
              provider: LIT_PROTOCOL;
          };
          endsAt: string;
          globalReach?: boolean;
          hideFromFeed?: boolean;
          id?: string;
          links?: string[];
          locale?: string;
          location: string;
          marketplace?: {
              animation_url?: URI;
              attributes?: ({ value: string; displayType?: MarketplaceMetadataAttributeDisplayType | undefined; traitType?: string | undefined; })[];
              description?: Markdown;
              external_url?: URI;
              image?: URI;
              name?: string;
          };
          position?: `geo:${number},${number}`;
          schedulingAdjustments?: {
              timezoneId: "Africa/Abidjan" | "Africa/Accra" | "Africa/Addis_Ababa" | "Africa/Algiers" | "Africa/Asmera" | "Africa/Bamako" | "Africa/Bangui" | "Africa/Banjul" | "Africa/Bissau" | "Africa/Blantyre" | "Africa/Brazzaville" | "Africa/Bujumbura" | "Africa/Cairo" | "Africa/Casablanca" | "Africa/Ceuta" | "Africa/Conakry" | "Africa/Dakar" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Douala" | "Africa/El_Aaiun" | "Africa/Freetown" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Johannesburg" | "Africa/Juba" | "Africa/Kampala" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Lome" | "Africa/Luanda" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Malabo" | "Africa/Maputo" | "Africa/Maseru" | "Africa/Mbabane" | "Africa/Mogadishu" | "Africa/Monrovia" | "Africa/Nairobi" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Africa/Porto-Novo" | "Africa/Sao_Tome" | "Africa/Tripoli" | "Africa/Tunis" | "Africa/Windhoek" | "America/Adak" | "America/Anchorage" | "America/Anguilla" | "America/Antigua" | "America/Araguaina" | "America/Argentina/La_Rioja" | "America/Argentina/Rio_Gallegos" | "America/Argentina/Salta" | "America/Argentina/San_Juan" | "America/Argentina/San_Luis" | "America/Argentina/Tucuman" | "America/Argentina/Ushuaia" | "America/Aruba" | "America/Asuncion" | "America/Bahia" | "America/Bahia_Banderas" | "America/Barbados" | "America/Belem" | "America/Belize" | "America/Blanc-Sablon" | "America/Boa_Vista" | "America/Bogota" | "America/Boise" | "America/Buenos_Aires" | "America/Cambridge_Bay" | "America/Campo_Grande" | "America/Cancun" | "America/Caracas" | "America/Catamarca" | "America/Cayenne" | "America/Cayman" | "America/Chicago" | "America/Chihuahua" | "America/Ciudad_Juarez" | "America/Coral_Harbour" | "America/Cordoba" | "America/Costa_Rica" | "America/Creston" | "America/Cuiaba" | "America/Curacao" | "America/Danmarkshavn" | "America/Dawson" | "America/Dawson_Creek" | "America/Denver" | "America/Detroit" | "America/Dominica" | "America/Edmonton" | "America/Eirunepe" | "America/El_Salvador" | "America/Fort_Nelson" | "America/Fortaleza" | "America/Glace_Bay" | "America/Godthab" | "America/Goose_Bay" | "America/Grand_Turk" | "America/Grenada" | "America/Guadeloupe" | "America/Guatemala" | "America/Guayaquil" | "America/Guyana" | "America/Halifax" | "America/Havana" | "America/Hermosillo" | "America/Indiana/Knox" | "America/Indiana/Marengo" | "America/Indiana/Petersburg" | "America/Indiana/Tell_City" | "America/Indiana/Vevay" | "America/Indiana/Vincennes" | "America/Indiana/Winamac" | "America/Indianapolis" | "America/Inuvik" | "America/Iqaluit" | "America/Jamaica" | "America/Jujuy" | "America/Juneau" | "America/Kentucky/Monticello" | "America/Kralendijk" | "America/La_Paz" | "America/Lima" | "America/Los_Angeles" | "America/Louisville" | "America/Lower_Princes" | "America/Maceio" | "America/Managua" | "America/Manaus" | "America/Marigot" | "America/Martinique" | "America/Matamoros" | "America/Mazatlan" | "America/Mendoza" | "America/Menominee" | "America/Merida" | "America/Metlakatla" | "America/Mexico_City" | "America/Miquelon" | "America/Moncton" | "America/Monterrey" | "America/Montevideo" | "America/Montserrat" | "America/Nassau" | "America/New_York" | "America/Nipigon" | "America/Nome" | "America/Noronha" | "America/North_Dakota/Beulah" | "America/North_Dakota/Center" | "America/North_Dakota/New_Salem" | "America/Ojinaga" | "America/Panama" | "America/Pangnirtung" | "America/Paramaribo" | "America/Phoenix" | "America/Port-au-Prince" | "America/Port_of_Spain" | "America/Porto_Velho" | "America/Puerto_Rico" | "America/Punta_Arenas" | "America/Rainy_River" | "America/Rankin_Inlet" | "America/Recife" | "America/Regina" | "America/Resolute" | "America/Rio_Branco" | "America/Santa_Isabel" | "America/Santarem" | "America/Santiago" | "America/Santo_Domingo" | "America/Sao_Paulo" | "America/Scoresbysund" | "America/Sitka" | "America/St_Barthelemy" | "America/St_Johns" | "America/St_Kitts" | "America/St_Lucia" | "America/St_Thomas" | "America/St_Vincent" | "America/Swift_Current" | "America/Tegucigalpa" | "America/Thule" | "America/Thunder_Bay" | "America/Tijuana" | "America/Toronto" | "America/Tortola" | "America/Vancouver" | "America/Whitehorse" | "America/Winnipeg" | "America/Yakutat" | "America/Yellowknife" | "Antarctica/Casey" | "Antarctica/Davis" | "Antarctica/DumontDUrville" | "Antarctica/Macquarie" | "Antarctica/Mawson" | "Antarctica/McMurdo" | "Antarctica/Palmer" | "Antarctica/Rothera" | "Antarctica/Syowa" | "Antarctica/Troll" | "Antarctica/Vostok" | "Arctic/Longyearbyen" | "Asia/Aden" | "Asia/Almaty" | "Asia/Amman" | "Asia/Anadyr" | "Asia/Aqtau" | "Asia/Aqtobe" | "Asia/Ashgabat" | "Asia/Atyrau" | "Asia/Baghdad" | "Asia/Bahrain" | "Asia/Baku" | "Asia/Bangkok" | "Asia/Barnaul" | "Asia/Beirut" | "Asia/Bishkek" | "Asia/Brunei" | "Asia/Calcutta" | "Asia/Chita" | "Asia/Choibalsan" | "Asia/Colombo" | "Asia/Damascus" | "Asia/Dhaka" | "Asia/Dili" | "Asia/Dubai" | "Asia/Dushanbe" | "Asia/Famagusta" | "Asia/Gaza" | "Asia/Hebron" | "Asia/Hong_Kong" | "Asia/Hovd" | "Asia/Irkutsk" | "Asia/Jakarta" | "Asia/Jayapura" | "Asia/Jerusalem" | "Asia/Kabul" | "Asia/Kamchatka" | "Asia/Karachi" | "Asia/Katmandu" | "Asia/Khandyga" | "Asia/Krasnoyarsk" | "Asia/Kuala_Lumpur" | "Asia/Kuching" | "Asia/Kuwait" | "Asia/Macau" | "Asia/Magadan" | "Asia/Makassar" | "Asia/Manila" | "Asia/Muscat" | "Asia/Nicosia" | "Asia/Novokuznetsk" | "Asia/Novosibirsk" | "Asia/Omsk" | "Asia/Oral" | "Asia/Phnom_Penh" | "Asia/Pontianak" | "Asia/Pyongyang" | "Asia/Qatar" | "Asia/Qostanay" | "Asia/Qyzylorda" | "Asia/Rangoon" | "Asia/Riyadh" | "Asia/Saigon" | "Asia/Sakhalin" | "Asia/Samarkand" | "Asia/Seoul" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Srednekolymsk" | "Asia/Taipei" | "Asia/Tashkent" | "Asia/Tbilisi" | "Asia/Tehran" | "Asia/Thimphu" | "Asia/Tokyo" | "Asia/Tomsk" | "Asia/Ulaanbaatar" | "Asia/Urumqi" | "Asia/Ust-Nera" | "Asia/Vientiane" | "Asia/Vladivostok" | "Asia/Yakutsk" | "Asia/Yekaterinburg" | "Asia/Yerevan" | "Atlantic/Azores" | "Atlantic/Bermuda" | "Atlantic/Canary" | "Atlantic/Cape_Verde" | "Atlantic/Faeroe" | "Atlantic/Madeira" | "Atlantic/Reykjavik" | "Atlantic/South_Georgia" | "Atlantic/St_Helena" | "Atlantic/Stanley" | "Australia/Adelaide" | "Australia/Brisbane" | "Australia/Broken_Hill" | "Australia/Currie" | "Australia/Darwin" | "Australia/Eucla" | "Australia/Hobart" | "Australia/Lindeman" | "Australia/Lord_Howe" | "Australia/Melbourne" | "Australia/Perth" | "Australia/Sydney" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Astrakhan" | "Europe/Athens" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Bucharest" | "Europe/Budapest" | "Europe/Busingen" | "Europe/Chisinau" | "Europe/Copenhagen" | "Europe/Dublin" | "Europe/Gibraltar" | "Europe/Guernsey" | "Europe/Helsinki" | "Europe/Isle_of_Man" | "Europe/Istanbul" | "Europe/Jersey" | "Europe/Kaliningrad" | "Europe/Kiev" | "Europe/Kirov" | "Europe/Lisbon" | "Europe/Ljubljana" | "Europe/London" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Malta" | "Europe/Mariehamn" | "Europe/Minsk" | "Europe/Monaco" | "Europe/Moscow" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Riga" | "Europe/Rome" | "Europe/Samara" | "Europe/San_Marino" | "Europe/Sarajevo" | "Europe/Saratov" | "Europe/Simferopol" | "Europe/Skopje" | "Europe/Sofia" | "Europe/Stockholm" | "Europe/Tallinn" | "Europe/Tirane" | "Europe/Ulyanovsk" | "Europe/Uzhgorod" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Vilnius" | "Europe/Volgograd" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zaporozhye" | "Europe/Zurich" | "Indian/Antananarivo" | "Indian/Chagos" | "Indian/Christmas" | "Indian/Cocos" | "Indian/Comoro" | "Indian/Kerguelen" | "Indian/Mahe" | "Indian/Maldives" | "Indian/Mauritius" | "Indian/Mayotte" | "Indian/Reunion" | "Pacific/Apia" | "Pacific/Auckland" | "Pacific/Bougainville" | "Pacific/Chatham" | "Pacific/Easter" | "Pacific/Efate" | "Pacific/Enderbury" | "Pacific/Fakaofo" | "Pacific/Fiji" | "Pacific/Funafuti" | "Pacific/Galapagos" | "Pacific/Gambier" | "Pacific/Guadalcanal" | "Pacific/Guam" | "Pacific/Honolulu" | "Pacific/Johnston" | "Pacific/Kiritimati" | "Pacific/Kosrae" | "Pacific/Kwajalein" | "Pacific/Majuro" | "Pacific/Marquesas" | "Pacific/Midway" | "Pacific/Nauru" | "Pacific/Niue" | "Pacific/Norfolk" | "Pacific/Noumea" | "Pacific/Pago_Pago" | "Pacific/Palau" | "Pacific/Pitcairn" | "Pacific/Ponape" | "Pacific/Port_Moresby" | "Pacific/Rarotonga" | "Pacific/Saipan" | "Pacific/Tahiti" | "Pacific/Tarawa" | "Pacific/Tongatapu" | "Pacific/Truk" | "Pacific/Wake" | "Pacific/Wallis";
              timezoneOffset: number;
          };
          startsAt: string;
          tags?: string[];
      }
      +

      EventOptions

      +
      +
      +
        +
      • +
        Optional address?: {
            country: string;
            formatted?: string;
            locality: string;
            postalCode?: string;
            region?: string;
            streetAddress?: string;
        }
        +
          +
        • +
          country: string
          • +
        • +
          Optional formatted?: string
          • +
        • +
          locality: string
          • +
        • +
          Optional postalCode?: string
          • +
        • +
          Optional region?: string
          • +
        • +
          Optional streetAddress?: string
        • +
      • +
        Optional appId?: string
        • +
      • +
        Optional attachments?: ({
            artist?: string;
            attributes?: (({ value: "true" | "false"; type: MetadataAttributeType.BOOLEAN; key: string; }) | ({ value: string; type: MetadataAttributeType.DATE; key: string; }) | ({ value: string; type: MetadataAttributeType.NUMBER; key: string; }) | ({ value: string; type: MetadataAttributeType.STRING; key: string; }) | ({ value: string; type: MetadataAttributeType.JSON; key: string; }))[];
            cover?: string;
            credits?: string;
            duration?: number;
            genre?: string;
            item: string;
            kind?: MUSIC | PODCAST | AUDIOBOOK | VOICE_NOTE | SOUND | OTHER;
            license?: CCO | CC_BY | CC_BY_ND | CC_BY_NC | TBNL_C_D_PL_Legal | TBNL_C_DT_PL_Legal | TBNL_C_ND_PL_Legal | TBNL_C_D_NPL_Legal | TBNL_C_DT_NPL_Legal | TBNL_C_DTSA_PL_Legal | TBNL_C_DTSA_NPL_Legal | TBNL_C_ND_NPL_Legal | TBNL_C_D_PL_Ledger | TBNL_C_DT_PL_Ledger | TBNL_C_ND_PL_Ledger | TBNL_C_D_NPL_Ledger | TBNL_C_DT_NPL_Ledger | TBNL_C_DTSA_PL_Ledger | TBNL_C_DTSA_NPL_Ledger | TBNL_C_ND_NPL_Ledger | TBNL_NC_D_PL_Legal | TBNL_NC_DT_PL_Legal | TBNL_NC_ND_PL_Legal | TBNL_NC_D_NPL_Legal | TBNL_NC_DT_NPL_Legal | TBNL_NC_DTSA_PL_Legal | TBNL_NC_DTSA_NPL_Legal | TBNL_NC_ND_NPL_Legal | TBNL_NC_D_PL_Ledger | TBNL_NC_DT_PL_Ledger | TBNL_NC_ND_PL_Ledger | TBNL_NC_D_NPL_Ledger | TBNL_NC_DT_NPL_Ledger | TBNL_NC_DTSA_PL_Ledger | TBNL_NC_DTSA_NPL_Ledger | TBNL_NC_ND_NPL_Ledger;
            lyrics?: string;
            recordLabel?: string;
            type: MediaAudioMimeType;
        } | {
            altTag?: string;
            attributes?: (({ value: "true" | "false"; type: MetadataAttributeType.BOOLEAN; key: string; }) | ({ value: string; type: MetadataAttributeType.DATE; key: string; }) | ({ value: string; type: MetadataAttributeType.NUMBER; key: string; }) | ({ value: string; type: MetadataAttributeType.STRING; key: string; }) | ({ value: string; type: MetadataAttributeType.JSON; key: string; }))[];
            item: string;
            license?: CCO | CC_BY | CC_BY_ND | CC_BY_NC | TBNL_C_D_PL_Legal | TBNL_C_DT_PL_Legal | TBNL_C_ND_PL_Legal | TBNL_C_D_NPL_Legal | TBNL_C_DT_NPL_Legal | TBNL_C_DTSA_PL_Legal | TBNL_C_DTSA_NPL_Legal | TBNL_C_ND_NPL_Legal | TBNL_C_D_PL_Ledger | TBNL_C_DT_PL_Ledger | TBNL_C_ND_PL_Ledger | TBNL_C_D_NPL_Ledger | TBNL_C_DT_NPL_Ledger | TBNL_C_DTSA_PL_Ledger | TBNL_C_DTSA_NPL_Ledger | TBNL_C_ND_NPL_Ledger | TBNL_NC_D_PL_Legal | TBNL_NC_DT_PL_Legal | TBNL_NC_ND_PL_Legal | TBNL_NC_D_NPL_Legal | TBNL_NC_DT_NPL_Legal | TBNL_NC_DTSA_PL_Legal | TBNL_NC_DTSA_NPL_Legal | TBNL_NC_ND_NPL_Legal | TBNL_NC_D_PL_Ledger | TBNL_NC_DT_PL_Ledger | TBNL_NC_ND_PL_Ledger | TBNL_NC_D_NPL_Ledger | TBNL_NC_DT_NPL_Ledger | TBNL_NC_DTSA_PL_Ledger | TBNL_NC_DTSA_NPL_Ledger | TBNL_NC_ND_NPL_Ledger;
            type: MediaImageMimeType;
        } | {
            altTag?: string;
            attributes?: (({ value: "true" | "false"; type: MetadataAttributeType.BOOLEAN; key: string; }) | ({ value: string; type: MetadataAttributeType.DATE; key: string; }) | ({ value: string; type: MetadataAttributeType.NUMBER; key: string; }) | ({ value: string; type: MetadataAttributeType.STRING; key: string; }) | ({ value: string; type: MetadataAttributeType.JSON; key: string; }))[];
            cover?: string;
            duration?: number;
            item: string;
            license?: CCO | CC_BY | CC_BY_ND | CC_BY_NC | TBNL_C_D_PL_Legal | TBNL_C_DT_PL_Legal | TBNL_C_ND_PL_Legal | TBNL_C_D_NPL_Legal | TBNL_C_DT_NPL_Legal | TBNL_C_DTSA_PL_Legal | TBNL_C_DTSA_NPL_Legal | TBNL_C_ND_NPL_Legal | TBNL_C_D_PL_Ledger | TBNL_C_DT_PL_Ledger | TBNL_C_ND_PL_Ledger | TBNL_C_D_NPL_Ledger | TBNL_C_DT_NPL_Ledger | TBNL_C_DTSA_PL_Ledger | TBNL_C_DTSA_NPL_Ledger | TBNL_C_ND_NPL_Ledger | TBNL_NC_D_PL_Legal | TBNL_NC_DT_PL_Legal | TBNL_NC_ND_PL_Legal | TBNL_NC_D_NPL_Legal | TBNL_NC_DT_NPL_Legal | TBNL_NC_DTSA_PL_Legal | TBNL_NC_DTSA_NPL_Legal | TBNL_NC_ND_NPL_Legal | TBNL_NC_D_PL_Ledger | TBNL_NC_DT_PL_Ledger | TBNL_NC_ND_PL_Ledger | TBNL_NC_D_NPL_Ledger | TBNL_NC_DT_NPL_Ledger | TBNL_NC_DTSA_PL_Ledger | TBNL_NC_DTSA_NPL_Ledger | TBNL_NC_ND_NPL_Ledger;
            type: MediaVideoMimeType;
        })[]
        • +
      • +
        Optional attributes?: ({
            key: string;
            type: BOOLEAN;
            value: "true" | "false";
        } | {
            key: string;
            type: DATE;
            value: string;
        } | {
            key: string;
            type: NUMBER;
            value: string;
        } | {
            key: string;
            type: STRING;
            value: string;
        } | {
            key: string;
            type: JSON;
            value: string;
        })[]
        • +
      • +
        Optional content?: string
        • +
      • +
        Optional contentWarning?: NSFW | SENSITIVE | SPOILER
        • +
      • +
        Optional encryptedWith?: {
            accessCondition: { type: ConditionType.OR; criteria: [{ type: ConditionType.NFT_OWNERSHIP; contract: { chainId: number; address: string; }; contractType: NftContractType; tokenIds?: string[] | undefined; } | ... 6 more ... | { ...; }, { ...; } | ... 6 more ... | { ...; }, ...({ ...; } | ... 6 more ... | { ...; })[]]; };
            encryptedPaths: string[];
            encryptionKey: string;
            provider: LIT_PROTOCOL;
        }
        +
          +
        • +
          accessCondition: { type: ConditionType.OR; criteria: [{ type: ConditionType.NFT_OWNERSHIP; contract: { chainId: number; address: string; }; contractType: NftContractType; tokenIds?: string[] | undefined; } | ... 6 more ... | { ...; }, { ...; } | ... 6 more ... | { ...; }, ...({ ...; } | ... 6 more ... | { ...; })[]]; }
          • +
        • +
          encryptedPaths: string[]
          • +
        • +
          encryptionKey: string
          • +
        • +
          provider: LIT_PROTOCOL
        • +
      • +
        endsAt: string
        • +
      • +
        Optional globalReach?: boolean
        • +
      • +
        Optional hideFromFeed?: boolean
        • +
      • +
        Optional id?: string
        +

        A unique identifier that in storages like IPFS ensures the uniqueness of the metadata URI.

        +
        +
        +

        Default Value

        a UUID
+
        +
        • +
      • +
        Optional links?: string[]
        • +
      • +
        Optional locale?: string
        +

        The language of the publication.

        +

        It's a locale string in the format of <language>-<region> or just <language>, where:

        +
          +
        • language is a two-letter ISO 639-1 language code, e.g. en or it
          • +
        • region is a two-letter ISO 3166-1 alpha-2 region code, e.g. US or IT
          • +
        +

        You can just pass in the language tag if you do not know the region or don't need to be specific.

        +
        +
        +

        Default Value

        en

        +
        • +
      • +
        location: string
        • +
      • +
        Optional marketplace?: {
            animation_url?: URI;
            attributes?: ({ value: string; displayType?: MarketplaceMetadataAttributeDisplayType | undefined; traitType?: string | undefined; })[];
            description?: Markdown;
            external_url?: URI;
            image?: URI;
            name?: string;
        }
        +
          +
        • +
          Optional animation_url?: URI
          • +
        • +
          Optional attributes?: ({ value: string; displayType?: MarketplaceMetadataAttributeDisplayType | undefined; traitType?: string | undefined; })[]
          • +
        • +
          Optional description?: Markdown
          • +
        • +
          Optional external_url?: URI
          • +
        • +
          Optional image?: URI
          • +
        • +
          Optional name?: string
        • +
      • +
        Optional position?: `geo:${number},${number}`
        • +
      • +
        Optional schedulingAdjustments?: {
            timezoneId: "Africa/Abidjan" | "Africa/Accra" | "Africa/Addis_Ababa" | "Africa/Algiers" | "Africa/Asmera" | "Africa/Bamako" | "Africa/Bangui" | "Africa/Banjul" | "Africa/Bissau" | "Africa/Blantyre" | "Africa/Brazzaville" | "Africa/Bujumbura" | "Africa/Cairo" | "Africa/Casablanca" | "Africa/Ceuta" | "Africa/Conakry" | "Africa/Dakar" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Douala" | "Africa/El_Aaiun" | "Africa/Freetown" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Johannesburg" | "Africa/Juba" | "Africa/Kampala" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Lome" | "Africa/Luanda" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Malabo" | "Africa/Maputo" | "Africa/Maseru" | "Africa/Mbabane" | "Africa/Mogadishu" | "Africa/Monrovia" | "Africa/Nairobi" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Africa/Porto-Novo" | "Africa/Sao_Tome" | "Africa/Tripoli" | "Africa/Tunis" | "Africa/Windhoek" | "America/Adak" | "America/Anchorage" | "America/Anguilla" | "America/Antigua" | "America/Araguaina" | "America/Argentina/La_Rioja" | "America/Argentina/Rio_Gallegos" | "America/Argentina/Salta" | "America/Argentina/San_Juan" | "America/Argentina/San_Luis" | "America/Argentina/Tucuman" | "America/Argentina/Ushuaia" | "America/Aruba" | "America/Asuncion" | "America/Bahia" | "America/Bahia_Banderas" | "America/Barbados" | "America/Belem" | "America/Belize" | "America/Blanc-Sablon" | "America/Boa_Vista" | "America/Bogota" | "America/Boise" | "America/Buenos_Aires" | "America/Cambridge_Bay" | "America/Campo_Grande" | "America/Cancun" | "America/Caracas" | "America/Catamarca" | "America/Cayenne" | "America/Cayman" | "America/Chicago" | "America/Chihuahua" | "America/Ciudad_Juarez" | "America/Coral_Harbour" | "America/Cordoba" | "America/Costa_Rica" | "America/Creston" | "America/Cuiaba" | "America/Curacao" | "America/Danmarkshavn" | "America/Dawson" | "America/Dawson_Creek" | "America/Denver" | "America/Detroit" | "America/Dominica" | "America/Edmonton" | "America/Eirunepe" | "America/El_Salvador" | "America/Fort_Nelson" | "America/Fortaleza" | "America/Glace_Bay" | "America/Godthab" | "America/Goose_Bay" | "America/Grand_Turk" | "America/Grenada" | "America/Guadeloupe" | "America/Guatemala" | "America/Guayaquil" | "America/Guyana" | "America/Halifax" | "America/Havana" | "America/Hermosillo" | "America/Indiana/Knox" | "America/Indiana/Marengo" | "America/Indiana/Petersburg" | "America/Indiana/Tell_City" | "America/Indiana/Vevay" | "America/Indiana/Vincennes" | "America/Indiana/Winamac" | "America/Indianapolis" | "America/Inuvik" | "America/Iqaluit" | "America/Jamaica" | "America/Jujuy" | "America/Juneau" | "America/Kentucky/Monticello" | "America/Kralendijk" | "America/La_Paz" | "America/Lima" | "America/Los_Angeles" | "America/Louisville" | "America/Lower_Princes" | "America/Maceio" | "America/Managua" | "America/Manaus" | "America/Marigot" | "America/Martinique" | "America/Matamoros" | "America/Mazatlan" | "America/Mendoza" | "America/Menominee" | "America/Merida" | "America/Metlakatla" | "America/Mexico_City" | "America/Miquelon" | "America/Moncton" | "America/Monterrey" | "America/Montevideo" | "America/Montserrat" | "America/Nassau" | "America/New_York" | "America/Nipigon" | "America/Nome" | "America/Noronha" | "America/North_Dakota/Beulah" | "America/North_Dakota/Center" | "America/North_Dakota/New_Salem" | "America/Ojinaga" | "America/Panama" | "America/Pangnirtung" | "America/Paramaribo" | "America/Phoenix" | "America/Port-au-Prince" | "America/Port_of_Spain" | "America/Porto_Velho" | "America/Puerto_Rico" | "America/Punta_Arenas" | "America/Rainy_River" | "America/Rankin_Inlet" | "America/Recife" | "America/Regina" | "America/Resolute" | "America/Rio_Branco" | "America/Santa_Isabel" | "America/Santarem" | "America/Santiago" | "America/Santo_Domingo" | "America/Sao_Paulo" | "America/Scoresbysund" | "America/Sitka" | "America/St_Barthelemy" | "America/St_Johns" | "America/St_Kitts" | "America/St_Lucia" | "America/St_Thomas" | "America/St_Vincent" | "America/Swift_Current" | "America/Tegucigalpa" | "America/Thule" | "America/Thunder_Bay" | "America/Tijuana" | "America/Toronto" | "America/Tortola" | "America/Vancouver" | "America/Whitehorse" | "America/Winnipeg" | "America/Yakutat" | "America/Yellowknife" | "Antarctica/Casey" | "Antarctica/Davis" | "Antarctica/DumontDUrville" | "Antarctica/Macquarie" | "Antarctica/Mawson" | "Antarctica/McMurdo" | "Antarctica/Palmer" | "Antarctica/Rothera" | "Antarctica/Syowa" | "Antarctica/Troll" | "Antarctica/Vostok" | "Arctic/Longyearbyen" | "Asia/Aden" | "Asia/Almaty" | "Asia/Amman" | "Asia/Anadyr" | "Asia/Aqtau" | "Asia/Aqtobe" | "Asia/Ashgabat" | "Asia/Atyrau" | "Asia/Baghdad" | "Asia/Bahrain" | "Asia/Baku" | "Asia/Bangkok" | "Asia/Barnaul" | "Asia/Beirut" | "Asia/Bishkek" | "Asia/Brunei" | "Asia/Calcutta" | "Asia/Chita" | "Asia/Choibalsan" | "Asia/Colombo" | "Asia/Damascus" | "Asia/Dhaka" | "Asia/Dili" | "Asia/Dubai" | "Asia/Dushanbe" | "Asia/Famagusta" | "Asia/Gaza" | "Asia/Hebron" | "Asia/Hong_Kong" | "Asia/Hovd" | "Asia/Irkutsk" | "Asia/Jakarta" | "Asia/Jayapura" | "Asia/Jerusalem" | "Asia/Kabul" | "Asia/Kamchatka" | "Asia/Karachi" | "Asia/Katmandu" | "Asia/Khandyga" | "Asia/Krasnoyarsk" | "Asia/Kuala_Lumpur" | "Asia/Kuching" | "Asia/Kuwait" | "Asia/Macau" | "Asia/Magadan" | "Asia/Makassar" | "Asia/Manila" | "Asia/Muscat" | "Asia/Nicosia" | "Asia/Novokuznetsk" | "Asia/Novosibirsk" | "Asia/Omsk" | "Asia/Oral" | "Asia/Phnom_Penh" | "Asia/Pontianak" | "Asia/Pyongyang" | "Asia/Qatar" | "Asia/Qostanay" | "Asia/Qyzylorda" | "Asia/Rangoon" | "Asia/Riyadh" | "Asia/Saigon" | "Asia/Sakhalin" | "Asia/Samarkand" | "Asia/Seoul" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Srednekolymsk" | "Asia/Taipei" | "Asia/Tashkent" | "Asia/Tbilisi" | "Asia/Tehran" | "Asia/Thimphu" | "Asia/Tokyo" | "Asia/Tomsk" | "Asia/Ulaanbaatar" | "Asia/Urumqi" | "Asia/Ust-Nera" | "Asia/Vientiane" | "Asia/Vladivostok" | "Asia/Yakutsk" | "Asia/Yekaterinburg" | "Asia/Yerevan" | "Atlantic/Azores" | "Atlantic/Bermuda" | "Atlantic/Canary" | "Atlantic/Cape_Verde" | "Atlantic/Faeroe" | "Atlantic/Madeira" | "Atlantic/Reykjavik" | "Atlantic/South_Georgia" | "Atlantic/St_Helena" | "Atlantic/Stanley" | "Australia/Adelaide" | "Australia/Brisbane" | "Australia/Broken_Hill" | "Australia/Currie" | "Australia/Darwin" | "Australia/Eucla" | "Australia/Hobart" | "Australia/Lindeman" | "Australia/Lord_Howe" | "Australia/Melbourne" | "Australia/Perth" | "Australia/Sydney" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Astrakhan" | "Europe/Athens" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Bucharest" | "Europe/Budapest" | "Europe/Busingen" | "Europe/Chisinau" | "Europe/Copenhagen" | "Europe/Dublin" | "Europe/Gibraltar" | "Europe/Guernsey" | "Europe/Helsinki" | "Europe/Isle_of_Man" | "Europe/Istanbul" | "Europe/Jersey" | "Europe/Kaliningrad" | "Europe/Kiev" | "Europe/Kirov" | "Europe/Lisbon" | "Europe/Ljubljana" | "Europe/London" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Malta" | "Europe/Mariehamn" | "Europe/Minsk" | "Europe/Monaco" | "Europe/Moscow" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Riga" | "Europe/Rome" | "Europe/Samara" | "Europe/San_Marino" | "Europe/Sarajevo" | "Europe/Saratov" | "Europe/Simferopol" | "Europe/Skopje" | "Europe/Sofia" | "Europe/Stockholm" | "Europe/Tallinn" | "Europe/Tirane" | "Europe/Ulyanovsk" | "Europe/Uzhgorod" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Vilnius" | "Europe/Volgograd" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zaporozhye" | "Europe/Zurich" | "Indian/Antananarivo" | "Indian/Chagos" | "Indian/Christmas" | "Indian/Cocos" | "Indian/Comoro" | "Indian/Kerguelen" | "Indian/Mahe" | "Indian/Maldives" | "Indian/Mauritius" | "Indian/Mayotte" | "Indian/Reunion" | "Pacific/Apia" | "Pacific/Auckland" | "Pacific/Bougainville" | "Pacific/Chatham" | "Pacific/Easter" | "Pacific/Efate" | "Pacific/Enderbury" | "Pacific/Fakaofo" | "Pacific/Fiji" | "Pacific/Funafuti" | "Pacific/Galapagos" | "Pacific/Gambier" | "Pacific/Guadalcanal" | "Pacific/Guam" | "Pacific/Honolulu" | "Pacific/Johnston" | "Pacific/Kiritimati" | "Pacific/Kosrae" | "Pacific/Kwajalein" | "Pacific/Majuro" | "Pacific/Marquesas" | "Pacific/Midway" | "Pacific/Nauru" | "Pacific/Niue" | "Pacific/Norfolk" | "Pacific/Noumea" | "Pacific/Pago_Pago" | "Pacific/Palau" | "Pacific/Pitcairn" | "Pacific/Ponape" | "Pacific/Port_Moresby" | "Pacific/Rarotonga" | "Pacific/Saipan" | "Pacific/Tahiti" | "Pacific/Tarawa" | "Pacific/Tongatapu" | "Pacific/Truk" | "Pacific/Wake" | "Pacific/Wallis";
            timezoneOffset: number;
        }
        +
          +
        • +
          timezoneId: "Africa/Abidjan" | "Africa/Accra" | "Africa/Addis_Ababa" | "Africa/Algiers" | "Africa/Asmera" | "Africa/Bamako" | "Africa/Bangui" | "Africa/Banjul" | "Africa/Bissau" | "Africa/Blantyre" | "Africa/Brazzaville" | "Africa/Bujumbura" | "Africa/Cairo" | "Africa/Casablanca" | "Africa/Ceuta" | "Africa/Conakry" | "Africa/Dakar" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Douala" | "Africa/El_Aaiun" | "Africa/Freetown" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Johannesburg" | "Africa/Juba" | "Africa/Kampala" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Lome" | "Africa/Luanda" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Malabo" | "Africa/Maputo" | "Africa/Maseru" | "Africa/Mbabane" | "Africa/Mogadishu" | "Africa/Monrovia" | "Africa/Nairobi" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Africa/Porto-Novo" | "Africa/Sao_Tome" | "Africa/Tripoli" | "Africa/Tunis" | "Africa/Windhoek" | "America/Adak" | "America/Anchorage" | "America/Anguilla" | "America/Antigua" | "America/Araguaina" | "America/Argentina/La_Rioja" | "America/Argentina/Rio_Gallegos" | "America/Argentina/Salta" | "America/Argentina/San_Juan" | "America/Argentina/San_Luis" | "America/Argentina/Tucuman" | "America/Argentina/Ushuaia" | "America/Aruba" | "America/Asuncion" | "America/Bahia" | "America/Bahia_Banderas" | "America/Barbados" | "America/Belem" | "America/Belize" | "America/Blanc-Sablon" | "America/Boa_Vista" | "America/Bogota" | "America/Boise" | "America/Buenos_Aires" | "America/Cambridge_Bay" | "America/Campo_Grande" | "America/Cancun" | "America/Caracas" | "America/Catamarca" | "America/Cayenne" | "America/Cayman" | "America/Chicago" | "America/Chihuahua" | "America/Ciudad_Juarez" | "America/Coral_Harbour" | "America/Cordoba" | "America/Costa_Rica" | "America/Creston" | "America/Cuiaba" | "America/Curacao" | "America/Danmarkshavn" | "America/Dawson" | "America/Dawson_Creek" | "America/Denver" | "America/Detroit" | "America/Dominica" | "America/Edmonton" | "America/Eirunepe" | "America/El_Salvador" | "America/Fort_Nelson" | "America/Fortaleza" | "America/Glace_Bay" | "America/Godthab" | "America/Goose_Bay" | "America/Grand_Turk" | "America/Grenada" | "America/Guadeloupe" | "America/Guatemala" | "America/Guayaquil" | "America/Guyana" | "America/Halifax" | "America/Havana" | "America/Hermosillo" | "America/Indiana/Knox" | "America/Indiana/Marengo" | "America/Indiana/Petersburg" | "America/Indiana/Tell_City" | "America/Indiana/Vevay" | "America/Indiana/Vincennes" | "America/Indiana/Winamac" | "America/Indianapolis" | "America/Inuvik" | "America/Iqaluit" | "America/Jamaica" | "America/Jujuy" | "America/Juneau" | "America/Kentucky/Monticello" | "America/Kralendijk" | "America/La_Paz" | "America/Lima" | "America/Los_Angeles" | "America/Louisville" | "America/Lower_Princes" | "America/Maceio" | "America/Managua" | "America/Manaus" | "America/Marigot" | "America/Martinique" | "America/Matamoros" | "America/Mazatlan" | "America/Mendoza" | "America/Menominee" | "America/Merida" | "America/Metlakatla" | "America/Mexico_City" | "America/Miquelon" | "America/Moncton" | "America/Monterrey" | "America/Montevideo" | "America/Montserrat" | "America/Nassau" | "America/New_York" | "America/Nipigon" | "America/Nome" | "America/Noronha" | "America/North_Dakota/Beulah" | "America/North_Dakota/Center" | "America/North_Dakota/New_Salem" | "America/Ojinaga" | "America/Panama" | "America/Pangnirtung" | "America/Paramaribo" | "America/Phoenix" | "America/Port-au-Prince" | "America/Port_of_Spain" | "America/Porto_Velho" | "America/Puerto_Rico" | "America/Punta_Arenas" | "America/Rainy_River" | "America/Rankin_Inlet" | "America/Recife" | "America/Regina" | "America/Resolute" | "America/Rio_Branco" | "America/Santa_Isabel" | "America/Santarem" | "America/Santiago" | "America/Santo_Domingo" | "America/Sao_Paulo" | "America/Scoresbysund" | "America/Sitka" | "America/St_Barthelemy" | "America/St_Johns" | "America/St_Kitts" | "America/St_Lucia" | "America/St_Thomas" | "America/St_Vincent" | "America/Swift_Current" | "America/Tegucigalpa" | "America/Thule" | "America/Thunder_Bay" | "America/Tijuana" | "America/Toronto" | "America/Tortola" | "America/Vancouver" | "America/Whitehorse" | "America/Winnipeg" | "America/Yakutat" | "America/Yellowknife" | "Antarctica/Casey" | "Antarctica/Davis" | "Antarctica/DumontDUrville" | "Antarctica/Macquarie" | "Antarctica/Mawson" | "Antarctica/McMurdo" | "Antarctica/Palmer" | "Antarctica/Rothera" | "Antarctica/Syowa" | "Antarctica/Troll" | "Antarctica/Vostok" | "Arctic/Longyearbyen" | "Asia/Aden" | "Asia/Almaty" | "Asia/Amman" | "Asia/Anadyr" | "Asia/Aqtau" | "Asia/Aqtobe" | "Asia/Ashgabat" | "Asia/Atyrau" | "Asia/Baghdad" | "Asia/Bahrain" | "Asia/Baku" | "Asia/Bangkok" | "Asia/Barnaul" | "Asia/Beirut" | "Asia/Bishkek" | "Asia/Brunei" | "Asia/Calcutta" | "Asia/Chita" | "Asia/Choibalsan" | "Asia/Colombo" | "Asia/Damascus" | "Asia/Dhaka" | "Asia/Dili" | "Asia/Dubai" | "Asia/Dushanbe" | "Asia/Famagusta" | "Asia/Gaza" | "Asia/Hebron" | "Asia/Hong_Kong" | "Asia/Hovd" | "Asia/Irkutsk" | "Asia/Jakarta" | "Asia/Jayapura" | "Asia/Jerusalem" | "Asia/Kabul" | "Asia/Kamchatka" | "Asia/Karachi" | "Asia/Katmandu" | "Asia/Khandyga" | "Asia/Krasnoyarsk" | "Asia/Kuala_Lumpur" | "Asia/Kuching" | "Asia/Kuwait" | "Asia/Macau" | "Asia/Magadan" | "Asia/Makassar" | "Asia/Manila" | "Asia/Muscat" | "Asia/Nicosia" | "Asia/Novokuznetsk" | "Asia/Novosibirsk" | "Asia/Omsk" | "Asia/Oral" | "Asia/Phnom_Penh" | "Asia/Pontianak" | "Asia/Pyongyang" | "Asia/Qatar" | "Asia/Qostanay" | "Asia/Qyzylorda" | "Asia/Rangoon" | "Asia/Riyadh" | "Asia/Saigon" | "Asia/Sakhalin" | "Asia/Samarkand" | "Asia/Seoul" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Srednekolymsk" | "Asia/Taipei" | "Asia/Tashkent" | "Asia/Tbilisi" | "Asia/Tehran" | "Asia/Thimphu" | "Asia/Tokyo" | "Asia/Tomsk" | "Asia/Ulaanbaatar" | "Asia/Urumqi" | "Asia/Ust-Nera" | "Asia/Vientiane" | "Asia/Vladivostok" | "Asia/Yakutsk" | "Asia/Yekaterinburg" | "Asia/Yerevan" | "Atlantic/Azores" | "Atlantic/Bermuda" | "Atlantic/Canary" | "Atlantic/Cape_Verde" | "Atlantic/Faeroe" | "Atlantic/Madeira" | "Atlantic/Reykjavik" | "Atlantic/South_Georgia" | "Atlantic/St_Helena" | "Atlantic/Stanley" | "Australia/Adelaide" | "Australia/Brisbane" | "Australia/Broken_Hill" | "Australia/Currie" | "Australia/Darwin" | "Australia/Eucla" | "Australia/Hobart" | "Australia/Lindeman" | "Australia/Lord_Howe" | "Australia/Melbourne" | "Australia/Perth" | "Australia/Sydney" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Astrakhan" | "Europe/Athens" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Bucharest" | "Europe/Budapest" | "Europe/Busingen" | "Europe/Chisinau" | "Europe/Copenhagen" | "Europe/Dublin" | "Europe/Gibraltar" | "Europe/Guernsey" | "Europe/Helsinki" | "Europe/Isle_of_Man" | "Europe/Istanbul" | "Europe/Jersey" | "Europe/Kaliningrad" | "Europe/Kiev" | "Europe/Kirov" | "Europe/Lisbon" | "Europe/Ljubljana" | "Europe/London" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Malta" | "Europe/Mariehamn" | "Europe/Minsk" | "Europe/Monaco" | "Europe/Moscow" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Riga" | "Europe/Rome" | "Europe/Samara" | "Europe/San_Marino" | "Europe/Sarajevo" | "Europe/Saratov" | "Europe/Simferopol" | "Europe/Skopje" | "Europe/Sofia" | "Europe/Stockholm" | "Europe/Tallinn" | "Europe/Tirane" | "Europe/Ulyanovsk" | "Europe/Uzhgorod" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Vilnius" | "Europe/Volgograd" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zaporozhye" | "Europe/Zurich" | "Indian/Antananarivo" | "Indian/Chagos" | "Indian/Christmas" | "Indian/Cocos" | "Indian/Comoro" | "Indian/Kerguelen" | "Indian/Mahe" | "Indian/Maldives" | "Indian/Mauritius" | "Indian/Mayotte" | "Indian/Reunion" | "Pacific/Apia" | "Pacific/Auckland" | "Pacific/Bougainville" | "Pacific/Chatham" | "Pacific/Easter" | "Pacific/Efate" | "Pacific/Enderbury" | "Pacific/Fakaofo" | "Pacific/Fiji" | "Pacific/Funafuti" | "Pacific/Galapagos" | "Pacific/Gambier" | "Pacific/Guadalcanal" | "Pacific/Guam" | "Pacific/Honolulu" | "Pacific/Johnston" | "Pacific/Kiritimati" | "Pacific/Kosrae" | "Pacific/Kwajalein" | "Pacific/Majuro" | "Pacific/Marquesas" | "Pacific/Midway" | "Pacific/Nauru" | "Pacific/Niue" | "Pacific/Norfolk" | "Pacific/Noumea" | "Pacific/Pago_Pago" | "Pacific/Palau" | "Pacific/Pitcairn" | "Pacific/Ponape" | "Pacific/Port_Moresby" | "Pacific/Rarotonga" | "Pacific/Saipan" | "Pacific/Tahiti" | "Pacific/Tarawa" | "Pacific/Tongatapu" | "Pacific/Truk" | "Pacific/Wake" | "Pacific/Wallis"
          • +
        • +
          timezoneOffset: number
        • +
      • +
        startsAt: string
        • +
      • +
        Optional tags?: string[]
    +

    Returns EventMetadata

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/extractVersion.html b/docs/functions/extractVersion.html new file mode 100644 index 0000000..f3b4ff0 --- /dev/null +++ b/docs/functions/extractVersion.html @@ -0,0 +1,67 @@ +extractVersion | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function extractVersion

+
+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      metadata: {
          $schema: LATEST;
          lens: { id: string; name?: string | undefined; bio?: Markdown | undefined; picture?: URI | undefined; coverPicture?: URI | undefined; attributes?: ({ value: "true" | "false"; type: MetadataAttributeType.BOOLEAN; key: string; } | { ...; } | { ...; } | { ...; } | { ...; })[] | undefined; appId?: AppId | undefined; };
          signature?: Signature;
      } | {
          $schema: THREE_D_LATEST;
          animation_url?: URI;
          attributes?: {
              displayType?: NUMBER | STRING | DATE;
              traitType?: string;
              value: string;
          }[];
          description?: Markdown;
          external_url?: URI;
          image?: URI;
          lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; assets: { format: ThreeDFormat; uri: string & { __type__: "URI"; }; playerUrl: string & { ...; }; zipPath?: string | undefined; license?: MetadataLicenseType | undefined; }[]; ... 8 more ...; attachments?: ({ ...; } | ......;
          name?: string;
          signature?: Signature;
      } | {
          $schema: ARTICLE_LATEST;
          animation_url?: URI;
          attributes?: {
              displayType?: NUMBER | STRING | DATE;
              traitType?: string;
              value: string;
          }[];
          description?: Markdown;
          external_url?: URI;
          image?: URI;
          lens: { id: string; content: (string | EncryptedString) & (string | EncryptedString | undefined); locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; ... 8 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
          name?: string;
          signature?: Signature;
      } | {
          $schema: AUDIO_LATEST;
          animation_url?: URI;
          attributes?: {
              displayType?: NUMBER | STRING | DATE;
              traitType?: string;
              value: string;
          }[];
          description?: Markdown;
          external_url?: URI;
          image?: URI;
          lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; audio: { type: MediaAudioMimeType; item: (string | EncryptedString) & (string | ... 1 more ... | undefined); ... 9 more ...; lyrics?: string | ... 1 more ... | undefined; }; ... 9 more ...; attachments?: ({ ...; } | ... 1...;
          name?: string;
          signature?: Signature;
      } | {
          $schema: CHECKING_IN_LATEST;
          animation_url?: URI;
          attributes?: {
              displayType?: NUMBER | STRING | DATE;
              traitType?: string;
              value: string;
          }[];
          description?: Markdown;
          external_url?: URI;
          image?: URI;
          lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; location: (string | EncryptedString) & (string | EncryptedString | undefined); ... 10 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
          name?: string;
          signature?: Signature;
      } | {
          $schema: EMBED_LATEST;
          animation_url?: URI;
          attributes?: {
              displayType?: NUMBER | STRING | DATE;
              traitType?: string;
              value: string;
          }[];
          description?: Markdown;
          external_url?: URI;
          image?: URI;
          lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; embed: (string | EncryptedString) & (string | EncryptedString | undefined); ... 8 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
          name?: string;
          signature?: Signature;
      } | {
          $schema: EVENT_LATEST;
          animation_url?: URI;
          attributes?: {
              displayType?: NUMBER | STRING | DATE;
              traitType?: string;
              value: string;
          }[];
          description?: Markdown;
          external_url?: URI;
          image?: URI;
          lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; location: (string | URI) & (string | URI | undefined); ... 14 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
          name?: string;
          signature?: Signature;
      } | {
          $schema: IMAGE_LATEST;
          animation_url?: URI;
          attributes?: {
              displayType?: NUMBER | STRING | DATE;
              traitType?: string;
              value: string;
          }[];
          description?: Markdown;
          external_url?: URI;
          image?: URI;
          lens: { id: string; image: { type: MediaImageMimeType; item: (string | EncryptedString) & (string | EncryptedString | undefined); attributes?: ({ ...; } | ... 3 more ... | { ...; })[] | undefined; altTag?: string | ... 1 more ... | undefined; license?: MetadataLicenseType | undefined; }; ... 11 more ...; attachments?: ({ ...;
          name?: string;
          signature?: Signature;
      } | {
          $schema: LINK_LATEST;
          animation_url?: URI;
          attributes?: {
              displayType?: NUMBER | STRING | DATE;
              traitType?: string;
              value: string;
          }[];
          description?: Markdown;
          external_url?: URI;
          image?: URI;
          lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; sharingLink: (string | EncryptedString) & (string | ... 1 more ... | undefined); ... 8 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
          name?: string;
          signature?: Signature;
      } | {
          $schema: LIVESTREAM_LATEST;
          animation_url?: URI;
          attributes?: {
              displayType?: NUMBER | STRING | DATE;
              traitType?: string;
              value: string;
          }[];
          description?: Markdown;
          external_url?: URI;
          image?: URI;
          lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; startsAt: (string | EncryptedString) & (string | EncryptedString | undefined); ... 13 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
          name?: string;
          signature?: Signature;
      } | {
          $schema: MINT_LATEST;
          animation_url?: URI;
          attributes?: {
              displayType?: NUMBER | STRING | DATE;
              traitType?: string;
              value: string;
          }[];
          description?: Markdown;
          external_url?: URI;
          image?: URI;
          lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; mintLink: (string | EncryptedString) & (string | EncryptedString | undefined); ... 8 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
          name?: string;
          signature?: Signature;
      } | {
          $schema: SPACE_LATEST;
          animation_url?: URI;
          attributes?: {
              displayType?: NUMBER | STRING | DATE;
              traitType?: string;
              value: string;
          }[];
          description?: Markdown;
          external_url?: URI;
          image?: URI;
          lens: { id: string; link: (string | EncryptedString) & (string | EncryptedString | undefined); locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; ... 10 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
          name?: string;
          signature?: Signature;
      } | {
          $schema: STORY_LATEST;
          animation_url?: URI;
          attributes?: {
              displayType?: NUMBER | STRING | DATE;
              traitType?: string;
              value: string;
          }[];
          description?: Markdown;
          external_url?: URI;
          image?: URI;
          lens: { id: string; asset: { type: MediaAudioMimeType; item: (string | EncryptedString) & (string | EncryptedString | undefined); ... 9 more ...; lyrics?: string | ... 1 more ... | undefined; } | { ...; } | { ...; }; ... 9 more ...; contentWarning?: PublicationContentWarning | undefined; };
          name?: string;
          signature?: Signature;
      } | {
          $schema: TEXT_ONLY_LATEST;
          animation_url?: URI;
          attributes?: {
              displayType?: NUMBER | STRING | DATE;
              traitType?: string;
              value: string;
          }[];
          description?: Markdown;
          external_url?: URI;
          image?: URI;
          lens: { id: string; content: (string | EncryptedString) & (string | EncryptedString | undefined); locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; ... 6 more ...; contentWarning?: PublicationContentWarning | undefined; };
          name?: string;
          signature?: Signature;
      } | {
          $schema: TRANSACTION_LATEST;
          animation_url?: URI;
          attributes?: {
              displayType?: NUMBER | STRING | DATE;
              traitType?: string;
              value: string;
          }[];
          description?: Markdown;
          external_url?: URI;
          image?: URI;
          lens: { id: string; type: TransactionMetadataType; chainId: number; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; ... 9 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
          name?: string;
          signature?: Signature;
      } | {
          $schema: VIDEO_LATEST;
          animation_url?: URI;
          attributes?: {
              displayType?: NUMBER | STRING | DATE;
              traitType?: string;
              value: string;
          }[];
          description?: Markdown;
          external_url?: URI;
          image?: URI;
          lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; video: { type: MediaVideoMimeType; item: (string | EncryptedString) & (string | ... 1 more ... | undefined); ... 4 more ...; license?: MetadataLicenseType | undefined; }; ... 9 more ...; attachments?: ({ ...; } | ... 1 mo...;
          name?: string;
          signature?: Signature;
      }
    +

    Returns string

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/followCondition-1.html b/docs/functions/followCondition-1.html new file mode 100644 index 0000000..bfa3dc1 --- /dev/null +++ b/docs/functions/followCondition-1.html @@ -0,0 +1,72 @@ +followCondition | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function followCondition

+
+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      input: Omit<{
          follow: string & {
              __type__: "ProfileId";
          };
          type: FOLLOW;
      }, "type">
    +

    Returns {
        follow: string & {
            __type__: "ProfileId";
        };
        type: FOLLOW;
    }

    +
      +
    • +
      follow: string & {
          __type__: "ProfileId";
      }
      • +
    • +
      type: FOLLOW
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/formatZodError.html b/docs/functions/formatZodError.html new file mode 100644 index 0000000..84d4b44 --- /dev/null +++ b/docs/functions/formatZodError.html @@ -0,0 +1,67 @@ +formatZodError | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function formatZodError

+
+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      zodError: ZodError<any>
    +

    Returns string

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/geoPoint-1.html b/docs/functions/geoPoint-1.html new file mode 100644 index 0000000..339342d --- /dev/null +++ b/docs/functions/geoPoint-1.html @@ -0,0 +1,70 @@ +geoPoint | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function geoPoint

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/geoUri-1.html b/docs/functions/geoUri-1.html new file mode 100644 index 0000000..ba1fc1f --- /dev/null +++ b/docs/functions/geoUri-1.html @@ -0,0 +1,75 @@ +geoUri | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function geoUri

+
+
    + +
  • +

    Helper to create a Geo URI from a GeoPoint.

    +
    +
    +

    Parameters

    +
      +
    • +
      point: {
          lat: number;
          lng: number;
      }
      +
        +
      • +
        lat: number
        • +
      • +
        lng: number
    +

    Returns GeoURI

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/image-16.html b/docs/functions/image-16.html new file mode 100644 index 0000000..6f43b31 --- /dev/null +++ b/docs/functions/image-16.html @@ -0,0 +1,152 @@ +image | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function image

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/link.html b/docs/functions/link.html new file mode 100644 index 0000000..847ca03 --- /dev/null +++ b/docs/functions/link.html @@ -0,0 +1,139 @@ +link | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function link

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/livestream.html b/docs/functions/livestream.html new file mode 100644 index 0000000..bee4ddb --- /dev/null +++ b/docs/functions/livestream.html @@ -0,0 +1,149 @@ +livestream | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function livestream

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/mint.html b/docs/functions/mint.html new file mode 100644 index 0000000..9267349 --- /dev/null +++ b/docs/functions/mint.html @@ -0,0 +1,139 @@ +mint | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function mint

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/mirror.html b/docs/functions/mirror.html new file mode 100644 index 0000000..8982598 --- /dev/null +++ b/docs/functions/mirror.html @@ -0,0 +1,88 @@ +mirror | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function mirror

+
+
    + +
  • +

    Creates a valid MirrorMetadata.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          appId?: string;
          globalReach?: boolean;
          hideFromFeed?: boolean;
          id?: string;
      }
      +

      MirrorOptions

      +
      +
      +
        +
      • +
        Optional appId?: string
        • +
      • +
        Optional globalReach?: boolean
        • +
      • +
        Optional hideFromFeed?: boolean
        • +
      • +
        Optional id?: string
        +

        A unique identifier that in storages like IPFS ensures the uniqueness of the metadata URI.

        +
        +
        +

        Default Value

        a UUID
+
        +
    +

    Returns MirrorMetadata

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/nftOwnershipCondition-1.html b/docs/functions/nftOwnershipCondition-1.html new file mode 100644 index 0000000..54b7a89 --- /dev/null +++ b/docs/functions/nftOwnershipCondition-1.html @@ -0,0 +1,67 @@ +nftOwnershipCondition | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function nftOwnershipCondition

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/orCondition-1.html b/docs/functions/orCondition-1.html new file mode 100644 index 0000000..63d1312 --- /dev/null +++ b/docs/functions/orCondition-1.html @@ -0,0 +1,72 @@ +orCondition | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function orCondition

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/profile.html b/docs/functions/profile.html new file mode 100644 index 0000000..b4f52ee --- /dev/null +++ b/docs/functions/profile.html @@ -0,0 +1,94 @@ +profile | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function profile

+
+
    + +
  • +

    Creates a valid ProfileMetadata.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          appId?: string;
          attributes?: ({
              key: string;
              type: BOOLEAN;
              value: "true" | "false";
          } | {
              key: string;
              type: DATE;
              value: string;
          } | {
              key: string;
              type: NUMBER;
              value: string;
          } | {
              key: string;
              type: STRING;
              value: string;
          } | {
              key: string;
              type: JSON;
              value: string;
          })[];
          bio?: string;
          coverPicture?: string;
          id?: string;
          name?: string;
          picture?: string;
      }
      +

      ProfileOptions

      +
      +
      +
        +
      • +
        Optional appId?: string
        • +
      • +
        Optional attributes?: ({
            key: string;
            type: BOOLEAN;
            value: "true" | "false";
        } | {
            key: string;
            type: DATE;
            value: string;
        } | {
            key: string;
            type: NUMBER;
            value: string;
        } | {
            key: string;
            type: STRING;
            value: string;
        } | {
            key: string;
            type: JSON;
            value: string;
        })[]
        • +
      • +
        Optional bio?: string
        • +
      • +
        Optional coverPicture?: string
        • +
      • +
        Optional id?: string
        +

        A unique identifier that in storages like IPFS ensures the uniqueness of the metadata URI.

        +
        +
        +

        Default Value

        a UUID
+
        +
        • +
      • +
        Optional name?: string
        • +
      • +
        Optional picture?: string
    +

    Returns ProfileMetadata

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/profileOwnershipCondition-1.html b/docs/functions/profileOwnershipCondition-1.html new file mode 100644 index 0000000..c47de8f --- /dev/null +++ b/docs/functions/profileOwnershipCondition-1.html @@ -0,0 +1,72 @@ +profileOwnershipCondition | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function profileOwnershipCondition

+
+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      input: Omit<{
          profileId: string & {
              __type__: "ProfileId";
          };
          type: PROFILE_OWNERSHIP;
      }, "type">
    +

    Returns {
        profileId: string & {
            __type__: "ProfileId";
        };
        type: PROFILE_OWNERSHIP;
    }

    +
      +
    • +
      profileId: string & {
          __type__: "ProfileId";
      }
      • +
    • +
      type: PROFILE_OWNERSHIP
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/space.html b/docs/functions/space.html new file mode 100644 index 0000000..12cb809 --- /dev/null +++ b/docs/functions/space.html @@ -0,0 +1,143 @@ +space | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function space

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/story.html b/docs/functions/story.html new file mode 100644 index 0000000..7dc6eda --- /dev/null +++ b/docs/functions/story.html @@ -0,0 +1,137 @@ +story | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function story

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/textOnly.html b/docs/functions/textOnly.html new file mode 100644 index 0000000..d430eff --- /dev/null +++ b/docs/functions/textOnly.html @@ -0,0 +1,135 @@ +textOnly | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function textOnly

+
+
    + +
  • +

    Creates a valid TextOnlyMetadata.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          appId?: string;
          attributes?: ({
              key: string;
              type: BOOLEAN;
              value: "true" | "false";
          } | {
              key: string;
              type: DATE;
              value: string;
          } | {
              key: string;
              type: NUMBER;
              value: string;
          } | {
              key: string;
              type: STRING;
              value: string;
          } | {
              key: string;
              type: JSON;
              value: string;
          })[];
          content: string;
          contentWarning?: NSFW | SENSITIVE | SPOILER;
          encryptedWith?: {
              accessCondition: { type: ConditionType.OR; criteria: [{ type: ConditionType.NFT_OWNERSHIP; contract: { chainId: number; address: string; }; contractType: NftContractType; tokenIds?: string[] | undefined; } | ... 6 more ... | { ...; }, { ...; } | ... 6 more ... | { ...; }, ...({ ...; } | ... 6 more ... | { ...; })[]]; };
              encryptedPaths: string[];
              encryptionKey: string;
              provider: LIT_PROTOCOL;
          };
          globalReach?: boolean;
          hideFromFeed?: boolean;
          id?: string;
          locale?: string;
          marketplace?: {
              animation_url?: URI;
              attributes?: ({ value: string; displayType?: MarketplaceMetadataAttributeDisplayType | undefined; traitType?: string | undefined; })[];
              description?: Markdown;
              external_url?: URI;
              image?: URI;
              name?: string;
          };
          tags?: string[];
      }
      +

      TextOnlyOptions

      +
      +
      +
        +
      • +
        Optional appId?: string
        • +
      • +
        Optional attributes?: ({
            key: string;
            type: BOOLEAN;
            value: "true" | "false";
        } | {
            key: string;
            type: DATE;
            value: string;
        } | {
            key: string;
            type: NUMBER;
            value: string;
        } | {
            key: string;
            type: STRING;
            value: string;
        } | {
            key: string;
            type: JSON;
            value: string;
        })[]
        • +
      • +
        content: string
        • +
      • +
        Optional contentWarning?: NSFW | SENSITIVE | SPOILER
        • +
      • +
        Optional encryptedWith?: {
            accessCondition: { type: ConditionType.OR; criteria: [{ type: ConditionType.NFT_OWNERSHIP; contract: { chainId: number; address: string; }; contractType: NftContractType; tokenIds?: string[] | undefined; } | ... 6 more ... | { ...; }, { ...; } | ... 6 more ... | { ...; }, ...({ ...; } | ... 6 more ... | { ...; })[]]; };
            encryptedPaths: string[];
            encryptionKey: string;
            provider: LIT_PROTOCOL;
        }
        +
          +
        • +
          accessCondition: { type: ConditionType.OR; criteria: [{ type: ConditionType.NFT_OWNERSHIP; contract: { chainId: number; address: string; }; contractType: NftContractType; tokenIds?: string[] | undefined; } | ... 6 more ... | { ...; }, { ...; } | ... 6 more ... | { ...; }, ...({ ...; } | ... 6 more ... | { ...; })[]]; }
          • +
        • +
          encryptedPaths: string[]
          • +
        • +
          encryptionKey: string
          • +
        • +
          provider: LIT_PROTOCOL
        • +
      • +
        Optional globalReach?: boolean
        • +
      • +
        Optional hideFromFeed?: boolean
        • +
      • +
        Optional id?: string
        +

        A unique identifier that in storages like IPFS ensures the uniqueness of the metadata URI.

        +
        +
        +

        Default Value

        a UUID
+
        +
        • +
      • +
        Optional locale?: string
        +

        The language of the publication.

        +

        It's a locale string in the format of <language>-<region> or just <language>, where:

        +
          +
        • language is a two-letter ISO 639-1 language code, e.g. en or it
          • +
        • region is a two-letter ISO 3166-1 alpha-2 region code, e.g. US or IT
          • +
        +

        You can just pass in the language tag if you do not know the region or don't need to be specific.

        +
        +
        +

        Default Value

        en

        +
        • +
      • +
        Optional marketplace?: {
            animation_url?: URI;
            attributes?: ({ value: string; displayType?: MarketplaceMetadataAttributeDisplayType | undefined; traitType?: string | undefined; })[];
            description?: Markdown;
            external_url?: URI;
            image?: URI;
            name?: string;
        }
        +
          +
        • +
          Optional animation_url?: URI
          • +
        • +
          Optional attributes?: ({ value: string; displayType?: MarketplaceMetadataAttributeDisplayType | undefined; traitType?: string | undefined; })[]
          • +
        • +
          Optional description?: Markdown
          • +
        • +
          Optional external_url?: URI
          • +
        • +
          Optional image?: URI
          • +
        • +
          Optional name?: string
        • +
      • +
        Optional tags?: string[]
    +

    Returns TextOnlyMetadata

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/threeD.html b/docs/functions/threeD.html new file mode 100644 index 0000000..15eeca7 --- /dev/null +++ b/docs/functions/threeD.html @@ -0,0 +1,139 @@ +threeD | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function threeD

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/transaction.html b/docs/functions/transaction.html new file mode 100644 index 0000000..454180b --- /dev/null +++ b/docs/functions/transaction.html @@ -0,0 +1,143 @@ +transaction | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function transaction

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/functions/video.html b/docs/functions/video.html new file mode 100644 index 0000000..d45a3e3 --- /dev/null +++ b/docs/functions/video.html @@ -0,0 +1,156 @@ +video | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Function video

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..7dab5ff --- /dev/null +++ b/docs/index.html @@ -0,0 +1,309 @@ +Lens Protocol Metadata Standards
+
+ +
+
+
+
+

Lens Protocol Metadata Standards

+

Lens Protocol Metadata Standards

Schema validation and TS types for LIP-2 Lens Protocol Metadata Standards.

+ +

Features

    +
  • Zod schema definitions
    • +
  • JSON Schema definitions
    • +
  • TypeScript type definitions
    • +
+

Installation

# npm:
npm install @lens-protocol/metadata zod

# yarn:
yarn add @lens-protocol/metadata zod

# pnpm:
pnpm add @lens-protocol/metadata zod
+
+
+

[!NOTE]
zod is marked as optional peer dependency, so if you all you need is the JSON Schema definitions, you can install @lens-protocol/metadata without zod.

+
+

Usage

Compose

Publication metadata

You can create compliant PublicationMetadata objects via the following builder functions:

+
import {
  article,
  audio,
  checkingIn,
  embed,
  event,
  image,
  link,
  livestream,
  mint,
  space,
  story,
  textOnly,
  threeD,
  transaction,
  video,
} from '@lens-protocol/metadata';

const json = article({
  content: 'The content of the article',
});
+
+
+

[!NOTE] +Use the type definitions to explore the available properties and their types. The builders will throw a ValidationError with instructions on how to fix the error if the object is not compliant with the schema.

+
+

We also provided a set of builder function for specific metadata sub-types (list to be expanded):

+
import { geoUri } from '@lens-protocol/metadata';

const uri = geoUri({
  lat: 51.5074,
  lng: 0.1278,
});
+
+

Mirror metadata

You can create compliant MirrorMetadata objects via the following builder function:

+
import { mirror } from '@lens-protocol/metadata';

const json = mirror({
  appId: 'foobar-app',
});
+
+
+

[!NOTE] +Use the type definitions to explore the available properties and their types. The builder will throw a ValidationError with instructions on how to fix the error if the object is not compliant with the schema.

+
+

Profile metadata

You can create compliant ProfileMetadata objects via the following builder function:

+
import { profile } from '@lens-protocol/metadata';

const json = profile({
  name: 'Bob',

  bio: 'I am a Lens user',
});
+
+
+

[!NOTE] +Use the type definitions to explore the available properties and their types. The builder will throw a ValidationError with instructions on how to fix the error if the object is not compliant with the schema.

+
+

Parse

Assuming we have 2 JS objects:

+
const valid = {
  /** example of valid metadata **/
};
const invalid = {
  /** example of invalid metadata **/
};
+
+

Publication metadata

Publication metadata schema is a union of all content schemas (e.g. ArticleMetadata, AudioMetadata, etc. but NOT MirrorMetadata).

+

Use it to parse the metadata referenced by contentURI of Comment, Mirror, and Quote publications.

+
import { PublicationMetadataSchema } from '@lens-protocol/metadata';

PublicationMetadataSchema.parse(valid); // => PublicationMetadata
PublicationMetadataSchema.parse(invalid); // => throws ZodError

// OR

PublicationMetadataSchema.safeParse(valid);
// => { success: true, data: PublicationMetadata }
PublicationMetadataSchema.safeParse(invalid);
// => { success: false, error: ZodError }
+
+

Mirror metadata

Mirror metadata schema serve the purpose allowing mirrors be associated to a given Lens app (via the appId) as well as specify some operational flags (e.g. hideFromFeed and globalReach).

+

Use it to parse the metadata referenced by metadataURI of Mirror publications.

+
import { MirrorMetadataSchema } from '@lens-protocol/metadata';

MirrorMetadataSchema.parse(valid); // => MirrorMetadata
MirrorMetadataSchema.parse(invalid); // => throws ZodError

// OR

MirrorMetadataSchema.safeParse(valid);
// => { success: true, data: MirrorMetadata }
MirrorMetadataSchema.safeParse(invalid);
// => { success: false, error: ZodError }
+
+

Profile metadata

import { ProfileMetadataSchema } from '@lens-protocol/metadata';

ProfileMetadataSchema.parse(valid); // => ProfileMetadata
ProfileMetadataSchema.parse(invalid); // => throws ZodError

// OR

ProfileMetadataSchema.safeParse(valid);
// => { success: true, data: ProfileMetadata }
ProfileMetadataSchema.safeParse(invalid);
// => { success: false, error: ZodError }
+
+

Extract version number

A convenience extractVersion function is available to extract the version from a parsed PublicationMetadata or ProfileMetadata.

+
import {
  extractVersion,
  PublicationMetadataSchema,
  ProfileMetadataSchema,
} from '@lens-protocol/metadata';

const publicationMetadata = PublicationMetadataSchema.parse(valid);

extractVersion(publicationMetadata); // => '3.0.0'

const profileMetadata = ProfileMetadataSchema.parse(valid);

extractVersion(profileMetadata); // => '2.0.0'
+
+

Format validation error

ZodError contains all the information needed to inform you about the validation error, but it's not very user friendly. You can use formatZodError to get a more readable error message.

+
import { PublicationMetadataSchema, formatZodError } from '@lens-protocol/metadata';

const result = PublicationMetadataSchema.safeParse(invalid);

if (!result.success) {
  console.log(formatZodError(result.error));
}
+
+

Types

Narrowing types

Every time you have a discriminated union, you can use the discriminant to narrow the type. See few examples below.

+

PublicationMetadata

import {
  PublicationMetadata,
  PublicationMetadataSchema,
  PublicationSchemaId,
} from '@lens-protocol/metadata';

const publicationMetadata = PublicationMetadataSchema.parse(valid);

switch (publicationMetadata.$schema) {
  case PublicationSchemaId.ARTICLE_LATEST:
    // publicationMetadata is ArticleMetadata
    break;
  case PublicationSchemaId.AUDIO_LATEST:
    // publicationMetadata is AudioMetadata
    break;
  case PublicationSchemaId.IMAGE_LATEST:
    // publicationMetadata is ImageMetadata
    break;
  case PublicationSchemaId.TEXT_ONLY_LATEST:
    // publicationMetadata is TextOnlyMetadata
    break;

  // ...
}
+
+

AccessCondition

import { AccessCondition, ConditionType, PublicationMetadataSchema } from '@lens-protocol/metadata';

const publicationMetadata = PublicationMetadataSchema.parse(valid);

switch (publicationMetadata.encryptedWith?.accessCondition.type) {
  case ConditionType.AND:
    // accessCondition is AndCondition
    break;
  case ConditionType.OR:
    // accessCondition is OrCondition
    break;
  case ConditionType.NFT_OWNERSHIP:
    // accessCondition is NftOwnershipCondition
    break;
  case ConditionType.EOA_OWNERSHIP:
    // accessCondition is EoaOwnershipCondition
    break;

  // ...
}
+
+

MetadataAttribute

import { MetadataAttribute, MetadataAttributeType } from '@lens-protocol/metadata';

switch (attribute.type) {
  case MetadataAttributeType.BOOLEAN:
    // attribute is BooleanAttribute
    // value is a string "true" or "false"
    break;
  case MetadataAttributeType.DATE:
    // attribute is DateAttribute
    // value is a string in ISO 8601 format
    break;
  case MetadataAttributeType.NUMBER:
    // attribute is NumberAttribute
    // value is a string containing a valid JS number
    break;
  case MetadataAttributeType.STRING:
    // attribute is StringAttribute
    // value is a string
    break;
  case MetadataAttributeType.JSON:
    // attribute is JSONAttribute
    // value is a string allegedly containing a valid JSON, consumers should validate it
    break;
}
+
+

Other useful types

The package also exports all enums and types that you might need to work with the metadata.

+

Use your IDE's autocomplete to explore the available types.

+

Some examples:

+
import {
  // enums
  MediaAudioKind,
  MediaAudioMimeType,
  MediaImageMimeType,
  MediaVideoMimeType,
  MetadataAttributeType
  PublicationMainFocus,
  ThreeDFormat,

  // main types
  ArticleMetadata,
  AudioMetadata,
  CheckingInMetadata,
  EmbedMetadata,
  EventMetadata,
  ImageMetadata,
  LinkMetadata,
  LivestreamMetadata,
  MintMetadata,
  ProfileMetadata,
  PublicationMetadata,
  SpaceMetadata,
  StoryMetadata,
  TextOnlyMetadata,
  ThreeDMetadata,
  TransactionMetadata,
  VideoMetadata,

  // others
  MetadataAttribute,
  MediaAudio,
  MediaImage,
  MediaVideo,
  AnyMedia,
  GeoLocation,
  BooleanAttribute,
  DateAttribute,
  NumberAttribute,
  StringAttribute,
  JSONAttribute,

  // branded aliases
  Locale,
  Markdown,
  Signature,
  URI,
  AppId,
  Datetime,
} from '@lens-protocol/metadata';
+
+

Legacy metadata formats

The package also exports parsers for legacy metadata formats via the @lens-protocol/metadata/legacy entrypoint.

+
+

[!WARNING] +DO NOT mix and match legacy and new metadata TS types and enums. Although they share some similarities they are not meant to be interoperable. +For example if you are checking mainContentFocus of PublicationMetadataV2 use the PublicationMainFocus exported from @lens-protocol/metadata/legacy and NOT the one from the main @lens-protocol/metadata entrypoint.

+
+

You can parse legacy Publication Metadata v1 and v2 via:

+
import { PublicationMetadataSchema } from '@lens-protocol/metadata/legacy';

PublicationMetadataSchema.parse(valid); // => PublicationMetadata
PublicationMetadataSchema.parse(invalid); // => throws ZodError

// OR

PublicationMetadataSchema.safeParse(valid);
// => { success: true, data: PublicationMetadata }
PublicationMetadataSchema.safeParse(invalid);
// => { success: false, error: ZodError }
+
+

Legacy PublicationMetadata is a discriminated union of PublicationMetadataV1 and PublicationMetadataV2 where the version property is the discriminant.

+

In turn legacy.PublicationMetadataV2 is a discriminated union of:

+
    +
  • PublicationMetadataV2Article
    • +
  • PublicationMetadataV2Audio
    • +
  • PublicationMetadataV2Embed
    • +
  • PublicationMetadataV2Image
    • +
  • PublicationMetadataV2Link
    • +
  • PublicationMetadataV2TextOnly
    • +
  • PublicationMetadataV2Video
    • +
+

where the mainContentFocus property is the discriminant.

+
import {
  PublicationMetadataSchema,
  PublicationMetadataVersion,
  PublicationMainFocus,
} from '@lens-protocol/metadata/legacy';

const publicationMetadata = PublicationMetadataSchema.parse(valid);

switch (publicationMetadata.version) {
  case PublicationMetadataVersion.V1:
    // publicationMetadata is PublicationMetadataV1
    break;
  case PublicationMetadataVersion.V2:
    // publicationMetadata is PublicationMetadataV2

    switch (publicationMetadata.mainContentFocus) {
      case PublicationMainFocus.ARTICLE:
        // publicationMetadata is PublicationMetadataV2Article
        break;
      case PublicationMainFocus.VIDEO:
        // publicationMetadata is PublicationMetadataV2Video
        break;

      // ...
    }
    break;
}
+
+

You can also parse legacy Profile Metadata (aka v1) via:

+
import { ProfileMetadataSchema } from '@lens-protocol/metadata/legacy';

ProfileMetadataSchema.parse(valid); // => ProfileMetadata
ProfileMetadataSchema.parse(invalid); // => throws ZodError

// OR

ProfileMetadataSchema.safeParse(valid);
// => { success: true, data: ProfileMetadata }
ProfileMetadataSchema.safeParse(invalid);
// => { success: false, error: ZodError }
+
+

Similarly to the main entrypoint the @lens-protocol/metadata/legacy entrypoint also exports all the types and enums that you might need to work with the legacy metadata (some examples below).

+
import {
  // enums
  AudioMimeType,
  ImageMimeType,
  PublicationMainFocus,
  PublicationMetadataVersion,
  VideoMimeType,

  // main types
  ProfileMetadata,
  PublicationMetadata,
  PublicationMetadataV1,
  PublicationMetadataV2,
  PublicationMetadataV2Article,
  PublicationMetadataV2Audio,
  PublicationMetadataV2Embed,
  PublicationMetadataV2Image,
  PublicationMetadataV2Link,
  PublicationMetadataV2TextOnly,
  PublicationMetadataV2Video,

  // others
  AccessCondition,
  AndCondition,
  CollectCondition,
  EncryptedFields,
  EncryptedMedia,
  EoaOwnership,
  Erc20Ownership,
  FollowCondition,
  MarketplaceMetadata,
  MarketplaceMetadataAttribute,
  Media,
  NftOwnership,
  OrCondition,
  ProfileMetadataAttribute,
  ProfileOwnership,

  // branded aliases
  Locale,
  Markdown,
  Signature,
  URI,
  AppId,
  Datetime,
} from '@lens-protocol/metadata/legacy';
+
+
+

[!NOTE] +If you find yourself in a position of importing from both @lens-protocol/metadata and @lens-protocol/metadata/legacy entrypoints in the same module. You can you can use ESModule aliasing to avoid conflicts: import * as legacy from '@lens-protocol/metadata/legacy' and then use the legacy types, enums, and parsers under legacy.*.

+
+

JSON schemas

Importing JSON schema in TypeScript is a simple as:

+
import audio from '@lens-protocol/metadata/jsonschemas/publications/audio/3.0.0.json' assert { type: 'json' };

import audio from '@lens-protocol/metadata/jsonschemas/publications/article/3.0.0.json' assert { type: 'json' };

import mirror from '@lens-protocol/metadata/jsonschemas/publications/mirror/1.0.0.json' assert { type: 'json' };

import profile from '@lens-protocol/metadata/jsonschemas/profile/2.0.0.json' assert { type: 'json' };
+
+

You can the use them in your JSON Schema validator of choice, for example ajv.

+

Versioning

The Lens Protocol Metadata Standards use a self-describing JSON format. All metadata files that adopt this standard MUST have a $schema property that identifies the schema the file conforms to.

+
{
  "$schema": "https://json-schemas.lens.dev/publications/article/3.0.0.json",

  "lens": {
    "id": "b3d7f1a0-1f75-11ec-9621-0242ac130002",
    "content": "The content of the article",
    "locale": "en"
  }
}
+
+

The $schema property is a URI that identify the schema type and its version.

+

Schemas are versioned using Semantic Versioning.

+
+

[!NOTE]
Even though schemas are identified by URIs, those identifiers are not necessarily network-addressable. They are just identifiers. +Generally, JSON schema validators don’t make HTTP requests (https://) to fetch schemas. Instead, they provide a way to load schemas into an internal schema database. When a schema is referenced by its URI identifier, the schema is retrieved from the internal schema database.

+
+

Future changes should aim to be backwards compatible as much as possible.

+

When adding a new version of a schema, the previous version should be kept for a reasonable amount of time to allow consumers to migrate and to support existing publications.

+

Adding a new schema

In this example we will add a new version of the AudioSchema schema, but the same process applies to all the other schemas.

+
    +
  • create a new PublicationSchemaId enum entry with value of PublicationSchemaId.AUDIO_LATEST. Name it after the current schema version (e.g. AUDIO_V1_0_0).
    • +
  • rename the existing AudioSchema into AudioV1_0_0Schema and update the $schema value to PublicationSchemaId.AUDIO_V1_0_0
    • +
  • increase the version number of the PublicationSchemaId.AUDIO_LATEST based on the nature of your changes. Remember to follow semver rules.
    • +
  • create a new AudioSchema with the new schema definition and use the PublicationSchemaId.AUDIO_LATEST as $schema value
    • +
  • update the scripts/build.ts script to include the new schema and old schema files under the correct version file name in the jsonschemas/publications/audio folder
    • +
  • release a new version of this package according to the nature of the changes (new major version of a schema = new major version of the package, etc.)
    • +
+

In case the changes are backwards compatible, you could create a single AudioMetadataDetailsSchema definition and just declare 2 schemas out of it, one for the old version and one for the new version. For example:

+
export const AudioMetadataDetailsSchema = metadataDetailsWith({
  mainContentFocus: mainContentFocus(PublicationMainFocus.AUDIO),

  audio: MediaAudioSchema,

  attachments: AnyMediaSchema.array()
    .min(1)
    .optional()
    .describe('The other attachments you want to include with it.'),

  /** e.g. new optional fields */
});
export type AudioMetadataDetails = z.infer<typeof AudioMetadataDetailsSchema>;

export const AudioSchema = publicationWith({
  $schema: z.literal(PublicationSchemaId.AUDIO_LATEST),
  lens: AudioMetadataDetailsSchema,
});
export type AudioMetadata = z.infer<typeof AudioSchema>;

export const AudioV1Schema = publicationWith({
  $schema: z.literal(PublicationSchemaId.AUDIO_V1_0_0),
  lens: AudioMetadataDetailsSchema,
});
export type AudioV1Metadata = z.infer<typeof AudioV1Schema>;
+
+

In this case consumers of this package can take advantage of the structural likeness and just do the following:

+
switch (publicationMetadata.$schema) {
  case PublicationSchemaId.AUDIO_V1_0_0:
  case PublicationSchemaId.AUDIO_LATEST:
    // publicationMetadata.lens is AudioMetadataDetails
    break;
  // ...
}
+
+

Contributing

To contribute to the Lens Protocol Metadata Standards, please fork this repository and submit a pull request with your changes.

+

To build the project, run:

+
pnpm build
+
+

Add changeset with:

+
pnpm changeset add
+
+

Use keepachangelog format for the changeset message.

+

Releasing

Release flow is managed by changesets.

+

To release a new version follow the steps below:

+
    +
  1. Create a new branch from main with the name release/<version>
    2. +
  2. Build the project
    3. +
+
pnpm install && pnpm build
+
+
    +
  1. Update relevant package.json's versions and update CHANGELOG.md for each package:
    2. +
+
pnpm changeset version
+
+
    +
  1. Review, commit and push the changes
    2. +
  2. Create a PR from release/<version> to main
    3. +
  3. Once approved, publish with (you need to be logged in to npm authorized to publish under @lens-protocol):
    4. +
+
pnpm changeset publish
+
+
    +
  1. Push the tags
    2. +
+
git push origin release/<version> --follow-tags
+
+
    +
  1. Merge the PR with a merge commit
    2. +
+

License

Lens Protocol Metadata Standards is MIT licensed

+

Support

See the Lens API and SDK channel on our Discord

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html new file mode 100644 index 0000000..4473a0c --- /dev/null +++ b/docs/modules.html @@ -0,0 +1,214 @@ +Lens Protocol Metadata Standards
+
+ +
+
+
+
+

Lens Protocol Metadata Standards

+
+
+

Index

+
+

Compose

+
ArticleOptions +AudioOptions +CheckingInOptions +EmbedOptions +EventOptions +ImageOptions +LinkOptions +LivestreamOptions +MintOptions +MirrorOptions +ProfileOptions +SpaceOptions +StoryOptions +TextOnlyOptions +ThreeDOptions +TransactionOptions +VideoOptions +article +asset +audio +checkingIn +embed +event +geoUri +image +link +livestream +mint +mirror +profile +space +story +textOnly +threeD +transaction +video +
+
+

Parse

+
MirrorMetadataSchema +ProfileMetadataSchema +PublicationMetadataSchema +geoPoint +
+
+

Other

+
ConditionComparisonOperator +ConditionType +EncryptionProvider +MarketplaceMetadataAttributeDisplayType +MediaAudioKind +MediaAudioMimeType +MediaImageMimeType +MediaVideoMimeType +MetadataAttributeType +MetadataLicenseType +MirrorSchemaId +NftContractType +ProfileSchemaId +PublicationContentWarning +PublicationMainFocus +PublicationSchemaId +ThreeDFormat +TransactionMetadataType +ValidationError +AccessCondition +Address +Amount +AndCondition +AnyMedia +AppId +ArticleMetadata +Asset +AudioMetadata +BooleanAttribute +ChainId +CheckingInMetadata +CollectCondition +DateAttribute +Datetime +EmbedMetadata +EncryptedPaths +EncryptedString +EoaOwnershipCondition +Erc20OwnershipCondition +EventMetadata +EvmAddress +FollowCondition +GeoPoint +GeoURI +ImageMetadata +JSONAttribute +LinkMetadata +LitEncryptionKey +LitEncryptionStrategy +LivestreamMetadata +Locale +Markdown +MarketplaceMetadata +MarketplaceMetadataAttribute +MediaAudio +MediaImage +MediaVideo +MetadataAttribute +MintMetadata +MirrorMetadata +NetworkAddress +NftOwnershipCondition +NumberAttribute +OrCondition +ProfileId +ProfileMetadata +ProfileMetadataDetails +ProfileOwnershipCondition +PublicationEncryptionStrategy +PublicationId +PublicationMetadata +SchedulingAdjustments +Signature +SimpleCondition +SpaceMetadata +StoryMetadata +StringAttribute +Tag +TextOnlyMetadata +ThreeDAsset +ThreeDMetadata +TimezoneId +TokenId +TransactionMetadata +TwoAtLeastArray +URI +VideoMetadata +AnyMediaSchema +BooleanAttributeSchema +DateAttributeSchema +JSONAttributeSchema +MarketplaceMetadataAttributeSchema +MarketplaceMetadataSchema +MediaAudioSchema +MediaImageSchema +MediaVideoSchema +MetadataAttributeSchema +MetadataLicenseTypeSchema +NumberAttributeSchema +StringAttributeSchema +ThreeDSchema +TimezoneIdSchema +timezones +andCondition +extractVersion +followCondition +formatZodError +nftOwnershipCondition +orCondition +profileOwnershipCondition +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/AccessCondition.html b/docs/types/AccessCondition.html new file mode 100644 index 0000000..c9e35f5 --- /dev/null +++ b/docs/types/AccessCondition.html @@ -0,0 +1,58 @@ +AccessCondition | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias AccessCondition

+
AccessCondition: OrCondition<{
    contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; };
    contractType: NftContractType;
    tokenIds?: TokenId[];
    type: NFT_OWNERSHIP;
} | {
    amount: { value: string; asset: { contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; decimals: number; }; };
    condition: ConditionComparisonOperator;
    type: ERC20_OWNERSHIP;
} | {
    address: string & {
        __type__: "EvmAddress";
    };
    type: EOA_OWNERSHIP;
} | {
    profileId: string & {
        __type__: "ProfileId";
    };
    type: PROFILE_OWNERSHIP;
} | {
    follow: string & {
        __type__: "ProfileId";
    };
    type: FOLLOW;
} | {
    publicationId: string & {
        __type__: "PublicationId";
    };
    thisPublication: boolean;
    type: COLLECT;
} | AndCondition<{
    contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; };
    contractType: NftContractType;
    tokenIds?: TokenId[];
    type: NFT_OWNERSHIP;
} | {
    amount: { value: string; asset: { contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; decimals: number; }; };
    condition: ConditionComparisonOperator;
    type: ERC20_OWNERSHIP;
} | {
    address: string & {
        __type__: "EvmAddress";
    };
    type: EOA_OWNERSHIP;
} | {
    profileId: string & {
        __type__: "ProfileId";
    };
    type: PROFILE_OWNERSHIP;
} | {
    follow: string & {
        __type__: "ProfileId";
    };
    type: FOLLOW;
} | {
    publicationId: string & {
        __type__: "PublicationId";
    };
    thisPublication: boolean;
    type: COLLECT;
}> | OrCondition<{
    contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; };
    contractType: NftContractType;
    tokenIds?: TokenId[];
    type: NFT_OWNERSHIP;
} | {
    amount: { value: string; asset: { contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; decimals: number; }; };
    condition: ConditionComparisonOperator;
    type: ERC20_OWNERSHIP;
} | {
    address: string & {
        __type__: "EvmAddress";
    };
    type: EOA_OWNERSHIP;
} | {
    profileId: string & {
        __type__: "ProfileId";
    };
    type: PROFILE_OWNERSHIP;
} | {
    follow: string & {
        __type__: "ProfileId";
    };
    type: FOLLOW;
} | {
    publicationId: string & {
        __type__: "PublicationId";
    };
    thisPublication: boolean;
    type: COLLECT;
}>>
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/Address.html b/docs/types/Address.html new file mode 100644 index 0000000..a40b4c5 --- /dev/null +++ b/docs/types/Address.html @@ -0,0 +1,76 @@ +Address | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias Address

+
Address: {
    country: Object;
    formatted?: string | EncryptedString;
    locality: Object;
    postalCode?: string | EncryptedString;
    region?: string | EncryptedString;
    streetAddress?: string | EncryptedString;
}
+

A physical address.

+
+
+

Type declaration

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/Amount.html b/docs/types/Amount.html new file mode 100644 index 0000000..0dee813 --- /dev/null +++ b/docs/types/Amount.html @@ -0,0 +1,68 @@ +Amount | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias Amount

+
Amount: {
    asset: { contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; decimals: number; };
    value: string;
}
+

An amount of a specific currency.

+
+
+

Type declaration

+
    +
  • +
    asset: { contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; decimals: number; }
    • +
  • +
    value: string
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/AndCondition.html b/docs/types/AndCondition.html new file mode 100644 index 0000000..d8ba458 --- /dev/null +++ b/docs/types/AndCondition.html @@ -0,0 +1,70 @@ +AndCondition | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias AndCondition<T>

+
AndCondition<T>: {
    criteria: TwoAtLeastArray<T>;
    type: AND;
}
+
+

Type Parameters

+
    +
  • +

    T

+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/AnyMedia.html b/docs/types/AnyMedia.html new file mode 100644 index 0000000..2879ed5 --- /dev/null +++ b/docs/types/AnyMedia.html @@ -0,0 +1,115 @@ +AnyMedia | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias AnyMedia

+
AnyMedia: {
    artist?: string | EncryptedString;
    attributes?: ({
        key: string;
        type: BOOLEAN;
        value: "true" | "false";
    } | {
        key: string;
        type: DATE;
        value: string;
    } | {
        key: string;
        type: NUMBER;
        value: string;
    } | {
        key: string;
        type: STRING;
        value: string;
    } | {
        key: string;
        type: JSON;
        value: string;
    })[];
    cover?: string | EncryptedString;
    credits?: string | EncryptedString;
    duration?: number;
    genre?: string | EncryptedString;
    item: Object;
    kind?: MUSIC | PODCAST | AUDIOBOOK | VOICE_NOTE | SOUND | OTHER;
    license?: CCO | CC_BY | CC_BY_ND | CC_BY_NC | TBNL_C_D_PL_Legal | TBNL_C_DT_PL_Legal | TBNL_C_ND_PL_Legal | TBNL_C_D_NPL_Legal | TBNL_C_DT_NPL_Legal | TBNL_C_DTSA_PL_Legal | TBNL_C_DTSA_NPL_Legal | TBNL_C_ND_NPL_Legal | TBNL_C_D_PL_Ledger | TBNL_C_DT_PL_Ledger | TBNL_C_ND_PL_Ledger | TBNL_C_D_NPL_Ledger | TBNL_C_DT_NPL_Ledger | TBNL_C_DTSA_PL_Ledger | TBNL_C_DTSA_NPL_Ledger | TBNL_C_ND_NPL_Ledger | TBNL_NC_D_PL_Legal | TBNL_NC_DT_PL_Legal | TBNL_NC_ND_PL_Legal | TBNL_NC_D_NPL_Legal | TBNL_NC_DT_NPL_Legal | TBNL_NC_DTSA_PL_Legal | TBNL_NC_DTSA_NPL_Legal | TBNL_NC_ND_NPL_Legal | TBNL_NC_D_PL_Ledger | TBNL_NC_DT_PL_Ledger | TBNL_NC_ND_PL_Ledger | TBNL_NC_D_NPL_Ledger | TBNL_NC_DT_NPL_Ledger | TBNL_NC_DTSA_PL_Ledger | TBNL_NC_DTSA_NPL_Ledger | TBNL_NC_ND_NPL_Ledger;
    lyrics?: string | EncryptedString;
    recordLabel?: string | EncryptedString;
    type: MediaAudioMimeType;
} | {
    altTag?: string | EncryptedString;
    attributes?: ({
        key: string;
        type: BOOLEAN;
        value: "true" | "false";
    } | {
        key: string;
        type: DATE;
        value: string;
    } | {
        key: string;
        type: NUMBER;
        value: string;
    } | {
        key: string;
        type: STRING;
        value: string;
    } | {
        key: string;
        type: JSON;
        value: string;
    })[];
    item: Object;
    license?: CCO | CC_BY | CC_BY_ND | CC_BY_NC | TBNL_C_D_PL_Legal | TBNL_C_DT_PL_Legal | TBNL_C_ND_PL_Legal | TBNL_C_D_NPL_Legal | TBNL_C_DT_NPL_Legal | TBNL_C_DTSA_PL_Legal | TBNL_C_DTSA_NPL_Legal | TBNL_C_ND_NPL_Legal | TBNL_C_D_PL_Ledger | TBNL_C_DT_PL_Ledger | TBNL_C_ND_PL_Ledger | TBNL_C_D_NPL_Ledger | TBNL_C_DT_NPL_Ledger | TBNL_C_DTSA_PL_Ledger | TBNL_C_DTSA_NPL_Ledger | TBNL_C_ND_NPL_Ledger | TBNL_NC_D_PL_Legal | TBNL_NC_DT_PL_Legal | TBNL_NC_ND_PL_Legal | TBNL_NC_D_NPL_Legal | TBNL_NC_DT_NPL_Legal | TBNL_NC_DTSA_PL_Legal | TBNL_NC_DTSA_NPL_Legal | TBNL_NC_ND_NPL_Legal | TBNL_NC_D_PL_Ledger | TBNL_NC_DT_PL_Ledger | TBNL_NC_ND_PL_Ledger | TBNL_NC_D_NPL_Ledger | TBNL_NC_DT_NPL_Ledger | TBNL_NC_DTSA_PL_Ledger | TBNL_NC_DTSA_NPL_Ledger | TBNL_NC_ND_NPL_Ledger;
    type: MediaImageMimeType;
} | {
    altTag?: string | EncryptedString;
    attributes?: ({
        key: string;
        type: BOOLEAN;
        value: "true" | "false";
    } | {
        key: string;
        type: DATE;
        value: string;
    } | {
        key: string;
        type: NUMBER;
        value: string;
    } | {
        key: string;
        type: STRING;
        value: string;
    } | {
        key: string;
        type: JSON;
        value: string;
    })[];
    cover?: string | EncryptedString;
    duration?: number;
    item: Object;
    license?: CCO | CC_BY | CC_BY_ND | CC_BY_NC | TBNL_C_D_PL_Legal | TBNL_C_DT_PL_Legal | TBNL_C_ND_PL_Legal | TBNL_C_D_NPL_Legal | TBNL_C_DT_NPL_Legal | TBNL_C_DTSA_PL_Legal | TBNL_C_DTSA_NPL_Legal | TBNL_C_ND_NPL_Legal | TBNL_C_D_PL_Ledger | TBNL_C_DT_PL_Ledger | TBNL_C_ND_PL_Ledger | TBNL_C_D_NPL_Ledger | TBNL_C_DT_NPL_Ledger | TBNL_C_DTSA_PL_Ledger | TBNL_C_DTSA_NPL_Ledger | TBNL_C_ND_NPL_Ledger | TBNL_NC_D_PL_Legal | TBNL_NC_DT_PL_Legal | TBNL_NC_ND_PL_Legal | TBNL_NC_D_NPL_Legal | TBNL_NC_DT_NPL_Legal | TBNL_NC_DTSA_PL_Legal | TBNL_NC_DTSA_NPL_Legal | TBNL_NC_ND_NPL_Legal | TBNL_NC_D_PL_Ledger | TBNL_NC_DT_PL_Ledger | TBNL_NC_ND_PL_Ledger | TBNL_NC_D_NPL_Ledger | TBNL_NC_DT_NPL_Ledger | TBNL_NC_DTSA_PL_Ledger | TBNL_NC_DTSA_NPL_Ledger | TBNL_NC_ND_NPL_Ledger;
    type: MediaVideoMimeType;
}
+
+

Type declaration

+
+
+

Type declaration

+
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/AppId.html b/docs/types/AppId.html new file mode 100644 index 0000000..f7c0613 --- /dev/null +++ b/docs/types/AppId.html @@ -0,0 +1,61 @@ +AppId | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias AppId

+
AppId: Brand<string, "AppId">
+

A Lens App identifier.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/ArticleMetadata.html b/docs/types/ArticleMetadata.html new file mode 100644 index 0000000..335d096 --- /dev/null +++ b/docs/types/ArticleMetadata.html @@ -0,0 +1,79 @@ +ArticleMetadata | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias ArticleMetadata

+
ArticleMetadata: {
    $schema: ARTICLE_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; content: (string | EncryptedString) & (string | EncryptedString | undefined); locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; ... 8 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
    name?: string;
    signature?: Signature;
}
+
+

Type declaration

+
    +
  • +
    $schema: ARTICLE_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; content: (string | EncryptedString) & (string | EncryptedString | undefined); locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; ... 8 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; }
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/ArticleOptions.html b/docs/types/ArticleOptions.html new file mode 100644 index 0000000..8235480 --- /dev/null +++ b/docs/types/ArticleOptions.html @@ -0,0 +1,59 @@ +ArticleOptions | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias ArticleOptions

+
ArticleOptions: PublicationMetadataOptions<ArticleMetadata>
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/Asset-1.html b/docs/types/Asset-1.html new file mode 100644 index 0000000..f42cb6f --- /dev/null +++ b/docs/types/Asset-1.html @@ -0,0 +1,68 @@ +Asset | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias Asset

+
Asset: {
    contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; };
    decimals: number;
}
+

A blockchain asset.

+
+
+

Type declaration

+
    +
  • +
    contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }
    • +
  • +
    decimals: number
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/AudioMetadata.html b/docs/types/AudioMetadata.html new file mode 100644 index 0000000..e9d6fa7 --- /dev/null +++ b/docs/types/AudioMetadata.html @@ -0,0 +1,79 @@ +AudioMetadata | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias AudioMetadata

+
AudioMetadata: {
    $schema: AUDIO_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; audio: { type: MediaAudioMimeType; item: (string | EncryptedString) & (string | ... 1 more ... | undefined); ... 9 more ...; lyrics?: string | ... 1 more ... | undefined; }; ... 9 more ...; attachments?: ({ ...; } | ... 1...;
    name?: string;
    signature?: Signature;
}
+
+

Type declaration

+
    +
  • +
    $schema: AUDIO_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; audio: { type: MediaAudioMimeType; item: (string | EncryptedString) & (string | ... 1 more ... | undefined); ... 9 more ...; lyrics?: string | ... 1 more ... | undefined; }; ... 9 more ...; attachments?: ({ ...; } | ... 1...
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/AudioOptions.html b/docs/types/AudioOptions.html new file mode 100644 index 0000000..053e28a --- /dev/null +++ b/docs/types/AudioOptions.html @@ -0,0 +1,59 @@ +AudioOptions | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias AudioOptions

+
AudioOptions: PublicationMetadataOptions<AudioMetadata>
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/BooleanAttribute.html b/docs/types/BooleanAttribute.html new file mode 100644 index 0000000..fdf7e42 --- /dev/null +++ b/docs/types/BooleanAttribute.html @@ -0,0 +1,67 @@ +BooleanAttribute | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias BooleanAttribute

+
BooleanAttribute: {
    key: string;
    type: BOOLEAN;
    value: "true" | "false";
}
+
+

Type declaration

+
    +
  • +
    key: string
    • +
  • +
    type: BOOLEAN
    • +
  • +
    value: "true" | "false"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/ChainId.html b/docs/types/ChainId.html new file mode 100644 index 0000000..9ff567e --- /dev/null +++ b/docs/types/ChainId.html @@ -0,0 +1,61 @@ +ChainId | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias ChainId

+
ChainId: Brand<number, "ChainId">
+

An EVM compatible Chain Id.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/CheckingInMetadata.html b/docs/types/CheckingInMetadata.html new file mode 100644 index 0000000..e61068f --- /dev/null +++ b/docs/types/CheckingInMetadata.html @@ -0,0 +1,79 @@ +CheckingInMetadata | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias CheckingInMetadata

+
CheckingInMetadata: {
    $schema: CHECKING_IN_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; location: (string | EncryptedString) & (string | EncryptedString | undefined); ... 10 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
    name?: string;
    signature?: Signature;
}
+
+

Type declaration

+
    +
  • +
    $schema: CHECKING_IN_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; location: (string | EncryptedString) & (string | EncryptedString | undefined); ... 10 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; }
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/CheckingInOptions.html b/docs/types/CheckingInOptions.html new file mode 100644 index 0000000..415b19f --- /dev/null +++ b/docs/types/CheckingInOptions.html @@ -0,0 +1,59 @@ +CheckingInOptions | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias CheckingInOptions

+
CheckingInOptions: PublicationMetadataOptions<CheckingInMetadata>
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/CollectCondition.html b/docs/types/CollectCondition.html new file mode 100644 index 0000000..6fcc87f --- /dev/null +++ b/docs/types/CollectCondition.html @@ -0,0 +1,67 @@ +CollectCondition | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias CollectCondition

+
CollectCondition: {
    publicationId: string & {
        __type__: "PublicationId";
    };
    thisPublication: boolean;
    type: COLLECT;
}
+
+

Type declaration

+
    +
  • +
    publicationId: string & {
        __type__: "PublicationId";
    }
    • +
  • +
    thisPublication: boolean
    • +
  • +
    type: COLLECT
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/DateAttribute.html b/docs/types/DateAttribute.html new file mode 100644 index 0000000..4067369 --- /dev/null +++ b/docs/types/DateAttribute.html @@ -0,0 +1,67 @@ +DateAttribute | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias DateAttribute

+
DateAttribute: {
    key: string;
    type: DATE;
    value: string;
}
+
+

Type declaration

+
    +
  • +
    key: string
    • +
  • +
    type: DATE
    • +
  • +
    value: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/Datetime.html b/docs/types/Datetime.html new file mode 100644 index 0000000..b1179ea --- /dev/null +++ b/docs/types/Datetime.html @@ -0,0 +1,61 @@ +Datetime | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias Datetime

+
Datetime: Brand<string, "Datetime">
+

An ISO 8601 in the JS simplified format: YYYY-MM-DDTHH:mm:ss.sssZ.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/EmbedMetadata.html b/docs/types/EmbedMetadata.html new file mode 100644 index 0000000..460d3d2 --- /dev/null +++ b/docs/types/EmbedMetadata.html @@ -0,0 +1,79 @@ +EmbedMetadata | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias EmbedMetadata

+
EmbedMetadata: {
    $schema: EMBED_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; embed: (string | EncryptedString) & (string | EncryptedString | undefined); ... 8 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
    name?: string;
    signature?: Signature;
}
+
+

Type declaration

+
    +
  • +
    $schema: EMBED_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; embed: (string | EncryptedString) & (string | EncryptedString | undefined); ... 8 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; }
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/EmbedOptions.html b/docs/types/EmbedOptions.html new file mode 100644 index 0000000..e5da935 --- /dev/null +++ b/docs/types/EmbedOptions.html @@ -0,0 +1,59 @@ +EmbedOptions | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias EmbedOptions

+
EmbedOptions: PublicationMetadataOptions<EmbedMetadata>
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/EncryptedPaths.html b/docs/types/EncryptedPaths.html new file mode 100644 index 0000000..a111562 --- /dev/null +++ b/docs/types/EncryptedPaths.html @@ -0,0 +1,59 @@ +EncryptedPaths | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias EncryptedPaths

+
EncryptedPaths: ZodArray<ZodString, "many">
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/EncryptedString.html b/docs/types/EncryptedString.html new file mode 100644 index 0000000..8eb85e8 --- /dev/null +++ b/docs/types/EncryptedString.html @@ -0,0 +1,61 @@ +EncryptedString | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias EncryptedString

+
EncryptedString: Brand<string, "EncryptedValue">
+

An encrypted value.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/EoaOwnershipCondition.html b/docs/types/EoaOwnershipCondition.html new file mode 100644 index 0000000..af4427d --- /dev/null +++ b/docs/types/EoaOwnershipCondition.html @@ -0,0 +1,65 @@ +EoaOwnershipCondition | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias EoaOwnershipCondition

+
EoaOwnershipCondition: {
    address: string & {
        __type__: "EvmAddress";
    };
    type: EOA_OWNERSHIP;
}
+
+

Type declaration

+
    +
  • +
    address: string & {
        __type__: "EvmAddress";
    }
    • +
  • +
    type: EOA_OWNERSHIP
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/Erc20OwnershipCondition.html b/docs/types/Erc20OwnershipCondition.html new file mode 100644 index 0000000..d884dfd --- /dev/null +++ b/docs/types/Erc20OwnershipCondition.html @@ -0,0 +1,67 @@ +Erc20OwnershipCondition | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias Erc20OwnershipCondition

+
Erc20OwnershipCondition: {
    amount: { value: string; asset: { contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; decimals: number; }; };
    condition: ConditionComparisonOperator;
    type: ERC20_OWNERSHIP;
}
+
+

Type declaration

+
    +
  • +
    amount: { value: string; asset: { contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; decimals: number; }; }
    • +
  • +
    condition: ConditionComparisonOperator
    • +
  • +
    type: ERC20_OWNERSHIP
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/EventMetadata.html b/docs/types/EventMetadata.html new file mode 100644 index 0000000..6191264 --- /dev/null +++ b/docs/types/EventMetadata.html @@ -0,0 +1,79 @@ +EventMetadata | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias EventMetadata

+
EventMetadata: {
    $schema: EVENT_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; location: (string | URI) & (string | URI | undefined); ... 14 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
    name?: string;
    signature?: Signature;
}
+
+

Type declaration

+
    +
  • +
    $schema: EVENT_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; location: (string | URI) & (string | URI | undefined); ... 14 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; }
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/EventOptions.html b/docs/types/EventOptions.html new file mode 100644 index 0000000..cc89902 --- /dev/null +++ b/docs/types/EventOptions.html @@ -0,0 +1,59 @@ +EventOptions | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias EventOptions

+
EventOptions: PublicationMetadataOptions<EventMetadata>
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/EvmAddress.html b/docs/types/EvmAddress.html new file mode 100644 index 0000000..6de2b69 --- /dev/null +++ b/docs/types/EvmAddress.html @@ -0,0 +1,61 @@ +EvmAddress | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias EvmAddress

+
EvmAddress: Brand<string, "EvmAddress">
+

An EVM compatible address.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/FollowCondition.html b/docs/types/FollowCondition.html new file mode 100644 index 0000000..eba61f0 --- /dev/null +++ b/docs/types/FollowCondition.html @@ -0,0 +1,65 @@ +FollowCondition | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias FollowCondition

+
FollowCondition: {
    follow: string & {
        __type__: "ProfileId";
    };
    type: FOLLOW;
}
+
+

Type declaration

+
    +
  • +
    follow: string & {
        __type__: "ProfileId";
    }
    • +
  • +
    type: FOLLOW
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/GeoPoint.html b/docs/types/GeoPoint.html new file mode 100644 index 0000000..6dfce7d --- /dev/null +++ b/docs/types/GeoPoint.html @@ -0,0 +1,68 @@ +GeoPoint | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias GeoPoint

+
GeoPoint: {
    lat: number;
    lng: number;
}
+

A geographic point.

+
+
+

Type declaration

+
    +
  • +
    lat: number
    • +
  • +
    lng: number
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/GeoURI.html b/docs/types/GeoURI.html new file mode 100644 index 0000000..9549cd4 --- /dev/null +++ b/docs/types/GeoURI.html @@ -0,0 +1,64 @@ +GeoURI | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias GeoURI

+
GeoURI: `geo:${number},${number}`
+

A Geographic coordinate as subset of Geo URI (RFC 5870).

+

Currently only supports the geo:lat,lng format.

+
+
+

See

https://tools.ietf.org/html/rfc5870

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/ImageMetadata.html b/docs/types/ImageMetadata.html new file mode 100644 index 0000000..3521418 --- /dev/null +++ b/docs/types/ImageMetadata.html @@ -0,0 +1,79 @@ +ImageMetadata | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias ImageMetadata

+
ImageMetadata: {
    $schema: IMAGE_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; image: { type: MediaImageMimeType; item: (string | EncryptedString) & (string | EncryptedString | undefined); attributes?: ({ ...; } | ... 3 more ... | { ...; })[] | undefined; altTag?: string | ... 1 more ... | undefined; license?: MetadataLicenseType | undefined; }; ... 11 more ...; attachments?: ({ ...;
    name?: string;
    signature?: Signature;
}
+
+

Type declaration

+
    +
  • +
    $schema: IMAGE_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; image: { type: MediaImageMimeType; item: (string | EncryptedString) & (string | EncryptedString | undefined); attributes?: ({ ...; } | ... 3 more ... | { ...; })[] | undefined; altTag?: string | ... 1 more ... | undefined; license?: MetadataLicenseType | undefined; }; ... 11 more ...; attachments?: ({ ...
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/ImageOptions.html b/docs/types/ImageOptions.html new file mode 100644 index 0000000..65d2e98 --- /dev/null +++ b/docs/types/ImageOptions.html @@ -0,0 +1,59 @@ +ImageOptions | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias ImageOptions

+
ImageOptions: PublicationMetadataOptions<ImageMetadata>
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/JSONAttribute.html b/docs/types/JSONAttribute.html new file mode 100644 index 0000000..6e3abb8 --- /dev/null +++ b/docs/types/JSONAttribute.html @@ -0,0 +1,67 @@ +JSONAttribute | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias JSONAttribute

+
JSONAttribute: {
    key: string;
    type: JSON;
    value: string;
}
+
+

Type declaration

+
    +
  • +
    key: string
    • +
  • +
    type: JSON
    • +
  • +
    value: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/LinkMetadata.html b/docs/types/LinkMetadata.html new file mode 100644 index 0000000..99aad5b --- /dev/null +++ b/docs/types/LinkMetadata.html @@ -0,0 +1,79 @@ +LinkMetadata | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias LinkMetadata

+
LinkMetadata: {
    $schema: LINK_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; sharingLink: (string | EncryptedString) & (string | ... 1 more ... | undefined); ... 8 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
    name?: string;
    signature?: Signature;
}
+
+

Type declaration

+
    +
  • +
    $schema: LINK_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; sharingLink: (string | EncryptedString) & (string | ... 1 more ... | undefined); ... 8 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; }
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/LinkOptions.html b/docs/types/LinkOptions.html new file mode 100644 index 0000000..8b9d389 --- /dev/null +++ b/docs/types/LinkOptions.html @@ -0,0 +1,59 @@ +LinkOptions | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias LinkOptions

+
LinkOptions: PublicationMetadataOptions<LinkMetadata>
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/LitEncryptionKey.html b/docs/types/LitEncryptionKey.html new file mode 100644 index 0000000..8e1d8bb --- /dev/null +++ b/docs/types/LitEncryptionKey.html @@ -0,0 +1,61 @@ +LitEncryptionKey | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias LitEncryptionKey

+
LitEncryptionKey: Brand<string, "LitEncryptionKey">
+

A symmetric encryption key.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/LitEncryptionStrategy.html b/docs/types/LitEncryptionStrategy.html new file mode 100644 index 0000000..0f8720e --- /dev/null +++ b/docs/types/LitEncryptionStrategy.html @@ -0,0 +1,69 @@ +LitEncryptionStrategy | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias LitEncryptionStrategy

+
LitEncryptionStrategy: {
    accessCondition: OrCondition<({ type: ConditionType.NFT_OWNERSHIP; contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; contractType: NftContractType; tokenIds?: TokenId[] | undefined; }) | ({ type: ConditionType.ERC20_OWNERSHIP; amount: { value: string; asset: { contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; decimals: number; }; }; condition: ConditionComparisonOperator; }) | ({ type: ConditionType.EOA_OWNERSHIP; address: string & { __type__: "EvmAddress"; }; }) | ({ type: ConditionType.PROFILE_OWNERSHIP; profileId: string & { __type__: "ProfileId"; }; }) | ({ type: ConditionType.FOLLOW; follow: string & { __type__: "ProfileId"; }; }) | ({ type: ConditionType.COLLECT; publicationId: string & { __type__: "PublicationId"; }; thisPublication: boolean; }) | AndCondition<({ type: ConditionType.NFT_OWNERSHIP; contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; contractType: NftContractType; tokenIds?: TokenId[] | undefined; }) | ({ type: ConditionType.ERC20_OWNERSHIP; amount: { value: string; asset: { contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; decimals: number; }; }; condition: ConditionComparisonOperator; }) | ({ type: ConditionType.EOA_OWNERSHIP; address: string & { __type__: "EvmAddress"; }; }) | ({ type: ConditionType.PROFILE_OWNERSHIP; profileId: string & { __type__: "ProfileId"; }; }) | ({ type: ConditionType.FOLLOW; follow: string & { __type__: "ProfileId"; }; }) | ({ type: ConditionType.COLLECT; publicationId: string & { __type__: "PublicationId"; }; thisPublication: boolean; })> | OrCondition<({ type: ConditionType.NFT_OWNERSHIP; contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; contractType: NftContractType; tokenIds?: TokenId[] | undefined; }) | ({ type: ConditionType.ERC20_OWNERSHIP; amount: { value: string; asset: { contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; decimals: number; }; }; condition: ConditionComparisonOperator; }) | ({ type: ConditionType.EOA_OWNERSHIP; address: string & { __type__: "EvmAddress"; }; }) | ({ type: ConditionType.PROFILE_OWNERSHIP; profileId: string & { __type__: "ProfileId"; }; }) | ({ type: ConditionType.FOLLOW; follow: string & { __type__: "ProfileId"; }; }) | ({ type: ConditionType.COLLECT; publicationId: string & { __type__: "PublicationId"; }; thisPublication: boolean; })>>;
    encryptedPaths: string[];
    encryptionKey: string & {
        __type__: "LitEncryptionKey";
    };
    provider: LIT_PROTOCOL;
}
+
+

Type declaration

+
    +
  • +
    accessCondition: OrCondition<({ type: ConditionType.NFT_OWNERSHIP; contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; contractType: NftContractType; tokenIds?: TokenId[] | undefined; }) | ({ type: ConditionType.ERC20_OWNERSHIP; amount: { value: string; asset: { contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; decimals: number; }; }; condition: ConditionComparisonOperator; }) | ({ type: ConditionType.EOA_OWNERSHIP; address: string & { __type__: "EvmAddress"; }; }) | ({ type: ConditionType.PROFILE_OWNERSHIP; profileId: string & { __type__: "ProfileId"; }; }) | ({ type: ConditionType.FOLLOW; follow: string & { __type__: "ProfileId"; }; }) | ({ type: ConditionType.COLLECT; publicationId: string & { __type__: "PublicationId"; }; thisPublication: boolean; }) | AndCondition<({ type: ConditionType.NFT_OWNERSHIP; contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; contractType: NftContractType; tokenIds?: TokenId[] | undefined; }) | ({ type: ConditionType.ERC20_OWNERSHIP; amount: { value: string; asset: { contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; decimals: number; }; }; condition: ConditionComparisonOperator; }) | ({ type: ConditionType.EOA_OWNERSHIP; address: string & { __type__: "EvmAddress"; }; }) | ({ type: ConditionType.PROFILE_OWNERSHIP; profileId: string & { __type__: "ProfileId"; }; }) | ({ type: ConditionType.FOLLOW; follow: string & { __type__: "ProfileId"; }; }) | ({ type: ConditionType.COLLECT; publicationId: string & { __type__: "PublicationId"; }; thisPublication: boolean; })> | OrCondition<({ type: ConditionType.NFT_OWNERSHIP; contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; contractType: NftContractType; tokenIds?: TokenId[] | undefined; }) | ({ type: ConditionType.ERC20_OWNERSHIP; amount: { value: string; asset: { contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; decimals: number; }; }; condition: ConditionComparisonOperator; }) | ({ type: ConditionType.EOA_OWNERSHIP; address: string & { __type__: "EvmAddress"; }; }) | ({ type: ConditionType.PROFILE_OWNERSHIP; profileId: string & { __type__: "ProfileId"; }; }) | ({ type: ConditionType.FOLLOW; follow: string & { __type__: "ProfileId"; }; }) | ({ type: ConditionType.COLLECT; publicationId: string & { __type__: "PublicationId"; }; thisPublication: boolean; })>>
    • +
  • +
    encryptedPaths: string[]
    • +
  • +
    encryptionKey: string & {
        __type__: "LitEncryptionKey";
    }
    • +
  • +
    provider: LIT_PROTOCOL
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/LivestreamMetadata.html b/docs/types/LivestreamMetadata.html new file mode 100644 index 0000000..9e06525 --- /dev/null +++ b/docs/types/LivestreamMetadata.html @@ -0,0 +1,79 @@ +LivestreamMetadata | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias LivestreamMetadata

+
LivestreamMetadata: {
    $schema: LIVESTREAM_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; startsAt: (string | EncryptedString) & (string | EncryptedString | undefined); ... 13 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
    name?: string;
    signature?: Signature;
}
+
+

Type declaration

+
    +
  • +
    $schema: LIVESTREAM_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; startsAt: (string | EncryptedString) & (string | EncryptedString | undefined); ... 13 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; }
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/LivestreamOptions.html b/docs/types/LivestreamOptions.html new file mode 100644 index 0000000..585a771 --- /dev/null +++ b/docs/types/LivestreamOptions.html @@ -0,0 +1,59 @@ +LivestreamOptions | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias LivestreamOptions

+
LivestreamOptions: PublicationMetadataOptions<LivestreamMetadata>
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/Locale.html b/docs/types/Locale.html new file mode 100644 index 0000000..f469fac --- /dev/null +++ b/docs/types/Locale.html @@ -0,0 +1,70 @@ +Locale | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias Locale

+
Locale: Brand<string, "Locale">
+

A locale identifier.

+

Syntax: [language]-[region] where:

+
    +
  • [language] is a lowercase ISO 639-1 language code
    • +
  • [region] is an optional uppercase ISO 3166-1 alpha-2 country code
    • +
+

You can pass just the language code, or both the language and region codes.

+
+
+

Example

- `en` any English
- `en-US` English as used in the United States
- `en-GB` English as used in the United Kingdom
+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/Markdown.html b/docs/types/Markdown.html new file mode 100644 index 0000000..4938d82 --- /dev/null +++ b/docs/types/Markdown.html @@ -0,0 +1,61 @@ +Markdown | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias Markdown

+
Markdown: Brand<string, "Markdown">
+

A markdown text.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/MarketplaceMetadata.html b/docs/types/MarketplaceMetadata.html new file mode 100644 index 0000000..08df714 --- /dev/null +++ b/docs/types/MarketplaceMetadata.html @@ -0,0 +1,73 @@ +MarketplaceMetadata | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias MarketplaceMetadata

+
MarketplaceMetadata: {
    animation_url?: URI;
    attributes?: ({ value: string; displayType?: MarketplaceMetadataAttributeDisplayType | undefined; traitType?: string | undefined; })[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    name?: string;
}
+
+

Type declaration

+
    +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: ({ value: string; displayType?: MarketplaceMetadataAttributeDisplayType | undefined; traitType?: string | undefined; })[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    Optional name?: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/MarketplaceMetadataAttribute.html b/docs/types/MarketplaceMetadataAttribute.html new file mode 100644 index 0000000..42fd1a0 --- /dev/null +++ b/docs/types/MarketplaceMetadataAttribute.html @@ -0,0 +1,67 @@ +MarketplaceMetadataAttribute | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias MarketplaceMetadataAttribute

+
MarketplaceMetadataAttribute: {
    displayType?: NUMBER | STRING | DATE;
    traitType?: string;
    value: string;
}
+
+

Type declaration

+
    +
  • +
    Optional displayType?: NUMBER | STRING | DATE
    • +
  • +
    Optional traitType?: string
    • +
  • +
    value: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/MediaAudio.html b/docs/types/MediaAudio.html new file mode 100644 index 0000000..3e104dc --- /dev/null +++ b/docs/types/MediaAudio.html @@ -0,0 +1,85 @@ +MediaAudio | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias MediaAudio

+
MediaAudio: {
    artist?: string | EncryptedString;
    attributes?: ({
        key: string;
        type: BOOLEAN;
        value: "true" | "false";
    } | {
        key: string;
        type: DATE;
        value: string;
    } | {
        key: string;
        type: NUMBER;
        value: string;
    } | {
        key: string;
        type: STRING;
        value: string;
    } | {
        key: string;
        type: JSON;
        value: string;
    })[];
    cover?: string | EncryptedString;
    credits?: string | EncryptedString;
    duration?: number;
    genre?: string | EncryptedString;
    item: Object;
    kind?: MUSIC | PODCAST | AUDIOBOOK | VOICE_NOTE | SOUND | OTHER;
    license?: CCO | CC_BY | CC_BY_ND | CC_BY_NC | TBNL_C_D_PL_Legal | TBNL_C_DT_PL_Legal | TBNL_C_ND_PL_Legal | TBNL_C_D_NPL_Legal | TBNL_C_DT_NPL_Legal | TBNL_C_DTSA_PL_Legal | TBNL_C_DTSA_NPL_Legal | TBNL_C_ND_NPL_Legal | TBNL_C_D_PL_Ledger | TBNL_C_DT_PL_Ledger | TBNL_C_ND_PL_Ledger | TBNL_C_D_NPL_Ledger | TBNL_C_DT_NPL_Ledger | TBNL_C_DTSA_PL_Ledger | TBNL_C_DTSA_NPL_Ledger | TBNL_C_ND_NPL_Ledger | TBNL_NC_D_PL_Legal | TBNL_NC_DT_PL_Legal | TBNL_NC_ND_PL_Legal | TBNL_NC_D_NPL_Legal | TBNL_NC_DT_NPL_Legal | TBNL_NC_DTSA_PL_Legal | TBNL_NC_DTSA_NPL_Legal | TBNL_NC_ND_NPL_Legal | TBNL_NC_D_PL_Ledger | TBNL_NC_DT_PL_Ledger | TBNL_NC_ND_PL_Ledger | TBNL_NC_D_NPL_Ledger | TBNL_NC_DT_NPL_Ledger | TBNL_NC_DTSA_PL_Ledger | TBNL_NC_DTSA_NPL_Ledger | TBNL_NC_ND_NPL_Ledger;
    lyrics?: string | EncryptedString;
    recordLabel?: string | EncryptedString;
    type: MediaAudioMimeType;
}
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/MediaImage.html b/docs/types/MediaImage.html new file mode 100644 index 0000000..f19f635 --- /dev/null +++ b/docs/types/MediaImage.html @@ -0,0 +1,71 @@ +MediaImage | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias MediaImage

+
MediaImage: {
    altTag?: string | EncryptedString;
    attributes?: ({
        key: string;
        type: BOOLEAN;
        value: "true" | "false";
    } | {
        key: string;
        type: DATE;
        value: string;
    } | {
        key: string;
        type: NUMBER;
        value: string;
    } | {
        key: string;
        type: STRING;
        value: string;
    } | {
        key: string;
        type: JSON;
        value: string;
    })[];
    item: Object;
    license?: CCO | CC_BY | CC_BY_ND | CC_BY_NC | TBNL_C_D_PL_Legal | TBNL_C_DT_PL_Legal | TBNL_C_ND_PL_Legal | TBNL_C_D_NPL_Legal | TBNL_C_DT_NPL_Legal | TBNL_C_DTSA_PL_Legal | TBNL_C_DTSA_NPL_Legal | TBNL_C_ND_NPL_Legal | TBNL_C_D_PL_Ledger | TBNL_C_DT_PL_Ledger | TBNL_C_ND_PL_Ledger | TBNL_C_D_NPL_Ledger | TBNL_C_DT_NPL_Ledger | TBNL_C_DTSA_PL_Ledger | TBNL_C_DTSA_NPL_Ledger | TBNL_C_ND_NPL_Ledger | TBNL_NC_D_PL_Legal | TBNL_NC_DT_PL_Legal | TBNL_NC_ND_PL_Legal | TBNL_NC_D_NPL_Legal | TBNL_NC_DT_NPL_Legal | TBNL_NC_DTSA_PL_Legal | TBNL_NC_DTSA_NPL_Legal | TBNL_NC_ND_NPL_Legal | TBNL_NC_D_PL_Ledger | TBNL_NC_DT_PL_Ledger | TBNL_NC_ND_PL_Ledger | TBNL_NC_D_NPL_Ledger | TBNL_NC_DT_NPL_Ledger | TBNL_NC_DTSA_PL_Ledger | TBNL_NC_DTSA_NPL_Ledger | TBNL_NC_ND_NPL_Ledger;
    type: MediaImageMimeType;
}
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/MediaVideo.html b/docs/types/MediaVideo.html new file mode 100644 index 0000000..e472202 --- /dev/null +++ b/docs/types/MediaVideo.html @@ -0,0 +1,75 @@ +MediaVideo | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias MediaVideo

+
MediaVideo: {
    altTag?: string | EncryptedString;
    attributes?: ({
        key: string;
        type: BOOLEAN;
        value: "true" | "false";
    } | {
        key: string;
        type: DATE;
        value: string;
    } | {
        key: string;
        type: NUMBER;
        value: string;
    } | {
        key: string;
        type: STRING;
        value: string;
    } | {
        key: string;
        type: JSON;
        value: string;
    })[];
    cover?: string | EncryptedString;
    duration?: number;
    item: Object;
    license?: CCO | CC_BY | CC_BY_ND | CC_BY_NC | TBNL_C_D_PL_Legal | TBNL_C_DT_PL_Legal | TBNL_C_ND_PL_Legal | TBNL_C_D_NPL_Legal | TBNL_C_DT_NPL_Legal | TBNL_C_DTSA_PL_Legal | TBNL_C_DTSA_NPL_Legal | TBNL_C_ND_NPL_Legal | TBNL_C_D_PL_Ledger | TBNL_C_DT_PL_Ledger | TBNL_C_ND_PL_Ledger | TBNL_C_D_NPL_Ledger | TBNL_C_DT_NPL_Ledger | TBNL_C_DTSA_PL_Ledger | TBNL_C_DTSA_NPL_Ledger | TBNL_C_ND_NPL_Ledger | TBNL_NC_D_PL_Legal | TBNL_NC_DT_PL_Legal | TBNL_NC_ND_PL_Legal | TBNL_NC_D_NPL_Legal | TBNL_NC_DT_NPL_Legal | TBNL_NC_DTSA_PL_Legal | TBNL_NC_DTSA_NPL_Legal | TBNL_NC_ND_NPL_Legal | TBNL_NC_D_PL_Ledger | TBNL_NC_DT_PL_Ledger | TBNL_NC_ND_PL_Ledger | TBNL_NC_D_NPL_Ledger | TBNL_NC_DT_NPL_Ledger | TBNL_NC_DTSA_PL_Ledger | TBNL_NC_DTSA_NPL_Ledger | TBNL_NC_ND_NPL_Ledger;
    type: MediaVideoMimeType;
}
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/MetadataAttribute.html b/docs/types/MetadataAttribute.html new file mode 100644 index 0000000..766b1c7 --- /dev/null +++ b/docs/types/MetadataAttribute.html @@ -0,0 +1,103 @@ +MetadataAttribute | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias MetadataAttribute

+
MetadataAttribute: {
    key: string;
    type: BOOLEAN;
    value: "true" | "false";
} | {
    key: string;
    type: DATE;
    value: string;
} | {
    key: string;
    type: NUMBER;
    value: string;
} | {
    key: string;
    type: STRING;
    value: string;
} | {
    key: string;
    type: JSON;
    value: string;
}
+
+

Type declaration

+
    +
  • +
    key: string
    • +
  • +
    type: BOOLEAN
    • +
  • +
    value: "true" | "false"
+
+

Type declaration

+
    +
  • +
    key: string
    • +
  • +
    type: DATE
    • +
  • +
    value: string
+
+

Type declaration

+
    +
  • +
    key: string
    • +
  • +
    type: NUMBER
    • +
  • +
    value: string
+
+

Type declaration

+
    +
  • +
    key: string
    • +
  • +
    type: STRING
    • +
  • +
    value: string
+
+

Type declaration

+
    +
  • +
    key: string
    • +
  • +
    type: JSON
    • +
  • +
    value: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/MintMetadata.html b/docs/types/MintMetadata.html new file mode 100644 index 0000000..988cd2b --- /dev/null +++ b/docs/types/MintMetadata.html @@ -0,0 +1,79 @@ +MintMetadata | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias MintMetadata

+
MintMetadata: {
    $schema: MINT_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; mintLink: (string | EncryptedString) & (string | EncryptedString | undefined); ... 8 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
    name?: string;
    signature?: Signature;
}
+
+

Type declaration

+
    +
  • +
    $schema: MINT_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; mintLink: (string | EncryptedString) & (string | EncryptedString | undefined); ... 8 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; }
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/MintOptions.html b/docs/types/MintOptions.html new file mode 100644 index 0000000..530e58d --- /dev/null +++ b/docs/types/MintOptions.html @@ -0,0 +1,59 @@ +MintOptions | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias MintOptions

+
MintOptions: PublicationMetadataOptions<MintMetadata>
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/MirrorMetadata.html b/docs/types/MirrorMetadata.html new file mode 100644 index 0000000..55fd52e --- /dev/null +++ b/docs/types/MirrorMetadata.html @@ -0,0 +1,65 @@ +MirrorMetadata | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias MirrorMetadata

+
MirrorMetadata: {
    $schema: LATEST;
    lens: { id: string; hideFromFeed?: boolean | undefined; globalReach?: boolean | undefined; appId?: AppId | undefined; };
}
+
+

Type declaration

+
    +
  • +
    $schema: LATEST
    • +
  • +
    lens: { id: string; hideFromFeed?: boolean | undefined; globalReach?: boolean | undefined; appId?: AppId | undefined; }
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/MirrorOptions.html b/docs/types/MirrorOptions.html new file mode 100644 index 0000000..94fc891 --- /dev/null +++ b/docs/types/MirrorOptions.html @@ -0,0 +1,59 @@ +MirrorOptions | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias MirrorOptions

+
MirrorOptions: Prettify<UnbrandAll<Overwrite<ExtractLensSpec<MirrorMetadata>, {
    id?: string;
}>>>
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/NetworkAddress.html b/docs/types/NetworkAddress.html new file mode 100644 index 0000000..1cae522 --- /dev/null +++ b/docs/types/NetworkAddress.html @@ -0,0 +1,68 @@ +NetworkAddress | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias NetworkAddress

+
NetworkAddress: {
    address: string & {
        __type__: "EvmAddress";
    };
    chainId: number & {
        __type__: "ChainId";
    };
}
+

An EVM compatible address on a specific chain.

+
+
+

Type declaration

+
    +
  • +
    address: string & {
        __type__: "EvmAddress";
    }
    • +
  • +
    chainId: number & {
        __type__: "ChainId";
    }
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/NftOwnershipCondition.html b/docs/types/NftOwnershipCondition.html new file mode 100644 index 0000000..efea0d6 --- /dev/null +++ b/docs/types/NftOwnershipCondition.html @@ -0,0 +1,69 @@ +NftOwnershipCondition | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias NftOwnershipCondition

+
NftOwnershipCondition: {
    contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; };
    contractType: NftContractType;
    tokenIds?: TokenId[];
    type: NFT_OWNERSHIP;
}
+
+

Type declaration

+
    +
  • +
    contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }
    • +
  • +
    contractType: NftContractType
    • +
  • +
    Optional tokenIds?: TokenId[]
    • +
  • +
    type: NFT_OWNERSHIP
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/NumberAttribute.html b/docs/types/NumberAttribute.html new file mode 100644 index 0000000..c081b24 --- /dev/null +++ b/docs/types/NumberAttribute.html @@ -0,0 +1,67 @@ +NumberAttribute | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias NumberAttribute

+
NumberAttribute: {
    key: string;
    type: NUMBER;
    value: string;
}
+
+

Type declaration

+
    +
  • +
    key: string
    • +
  • +
    type: NUMBER
    • +
  • +
    value: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/OrCondition.html b/docs/types/OrCondition.html new file mode 100644 index 0000000..bf12da6 --- /dev/null +++ b/docs/types/OrCondition.html @@ -0,0 +1,70 @@ +OrCondition | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias OrCondition<T>

+
OrCondition<T>: {
    criteria: TwoAtLeastArray<T>;
    type: OR;
}
+
+

Type Parameters

+
    +
  • +

    T

+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/ProfileId.html b/docs/types/ProfileId.html new file mode 100644 index 0000000..598c065 --- /dev/null +++ b/docs/types/ProfileId.html @@ -0,0 +1,61 @@ +ProfileId | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias ProfileId

+
ProfileId: Brand<string, "ProfileId">
+

A Profile identifier.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/ProfileMetadata.html b/docs/types/ProfileMetadata.html new file mode 100644 index 0000000..6e6056c --- /dev/null +++ b/docs/types/ProfileMetadata.html @@ -0,0 +1,67 @@ +ProfileMetadata | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias ProfileMetadata

+
ProfileMetadata: {
    $schema: LATEST;
    lens: { id: string; name?: string | undefined; bio?: Markdown | undefined; picture?: URI | undefined; coverPicture?: URI | undefined; attributes?: ({ value: "true" | "false"; type: MetadataAttributeType.BOOLEAN; key: string; } | { ...; } | { ...; } | { ...; } | { ...; })[] | undefined; appId?: AppId | undefined; };
    signature?: Signature;
}
+
+

Type declaration

+
    +
  • +
    $schema: LATEST
    • +
  • +
    lens: { id: string; name?: string | undefined; bio?: Markdown | undefined; picture?: URI | undefined; coverPicture?: URI | undefined; attributes?: ({ value: "true" | "false"; type: MetadataAttributeType.BOOLEAN; key: string; } | { ...; } | { ...; } | { ...; } | { ...; })[] | undefined; appId?: AppId | undefined; }
    • +
  • +
    Optional signature?: Signature
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/ProfileMetadataDetails.html b/docs/types/ProfileMetadataDetails.html new file mode 100644 index 0000000..d42f430 --- /dev/null +++ b/docs/types/ProfileMetadataDetails.html @@ -0,0 +1,75 @@ +ProfileMetadataDetails | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias ProfileMetadataDetails

+
ProfileMetadataDetails: {
    appId?: AppId;
    attributes?: (({ value: "true" | "false"; type: MetadataAttributeType.BOOLEAN; key: string; }) | ({ value: string; type: MetadataAttributeType.DATE; key: string; }) | ({ value: string; type: MetadataAttributeType.NUMBER; key: string; }) | ({ value: string; type: MetadataAttributeType.STRING; key: string; }) | ({ value: string; type: MetadataAttributeType.JSON; key: string; }))[];
    bio?: Markdown;
    coverPicture?: URI;
    id: string;
    name?: string;
    picture?: URI;
}
+
+

Type declaration

+
    +
  • +
    Optional appId?: AppId
    • +
  • +
    Optional attributes?: (({ value: "true" | "false"; type: MetadataAttributeType.BOOLEAN; key: string; }) | ({ value: string; type: MetadataAttributeType.DATE; key: string; }) | ({ value: string; type: MetadataAttributeType.NUMBER; key: string; }) | ({ value: string; type: MetadataAttributeType.STRING; key: string; }) | ({ value: string; type: MetadataAttributeType.JSON; key: string; }))[]
    • +
  • +
    Optional bio?: Markdown
    • +
  • +
    Optional coverPicture?: URI
    • +
  • +
    id: string
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional picture?: URI
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/ProfileOptions.html b/docs/types/ProfileOptions.html new file mode 100644 index 0000000..17c5693 --- /dev/null +++ b/docs/types/ProfileOptions.html @@ -0,0 +1,59 @@ +ProfileOptions | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias ProfileOptions

+
ProfileOptions: Prettify<UnbrandAll<Overwrite<ExtractLensSpec<ProfileMetadata>, {
    id?: string;
}>>>
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/ProfileOwnershipCondition.html b/docs/types/ProfileOwnershipCondition.html new file mode 100644 index 0000000..858c8ff --- /dev/null +++ b/docs/types/ProfileOwnershipCondition.html @@ -0,0 +1,65 @@ +ProfileOwnershipCondition | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias ProfileOwnershipCondition

+
ProfileOwnershipCondition: {
    profileId: string & {
        __type__: "ProfileId";
    };
    type: PROFILE_OWNERSHIP;
}
+
+

Type declaration

+
    +
  • +
    profileId: string & {
        __type__: "ProfileId";
    }
    • +
  • +
    type: PROFILE_OWNERSHIP
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/PublicationEncryptionStrategy.html b/docs/types/PublicationEncryptionStrategy.html new file mode 100644 index 0000000..a0dba0e --- /dev/null +++ b/docs/types/PublicationEncryptionStrategy.html @@ -0,0 +1,73 @@ +PublicationEncryptionStrategy | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias PublicationEncryptionStrategy

+
PublicationEncryptionStrategy: {
    accessCondition: OrCondition<({ type: ConditionType.NFT_OWNERSHIP; contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; contractType: NftContractType; tokenIds?: TokenId[] | undefined; }) | ({ type: ConditionType.ERC20_OWNERSHIP; amount: { value: string; asset: { contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; decimals: number; }; }; condition: ConditionComparisonOperator; }) | ({ type: ConditionType.EOA_OWNERSHIP; address: string & { __type__: "EvmAddress"; }; }) | ({ type: ConditionType.PROFILE_OWNERSHIP; profileId: string & { __type__: "ProfileId"; }; }) | ({ type: ConditionType.FOLLOW; follow: string & { __type__: "ProfileId"; }; }) | ({ type: ConditionType.COLLECT; publicationId: string & { __type__: "PublicationId"; }; thisPublication: boolean; }) | AndCondition<({ type: ConditionType.NFT_OWNERSHIP; contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; contractType: NftContractType; tokenIds?: TokenId[] | undefined; }) | ({ type: ConditionType.ERC20_OWNERSHIP; amount: { value: string; asset: { contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; decimals: number; }; }; condition: ConditionComparisonOperator; }) | ({ type: ConditionType.EOA_OWNERSHIP; address: string & { __type__: "EvmAddress"; }; }) | ({ type: ConditionType.PROFILE_OWNERSHIP; profileId: string & { __type__: "ProfileId"; }; }) | ({ type: ConditionType.FOLLOW; follow: string & { __type__: "ProfileId"; }; }) | ({ type: ConditionType.COLLECT; publicationId: string & { __type__: "PublicationId"; }; thisPublication: boolean; })> | OrCondition<({ type: ConditionType.NFT_OWNERSHIP; contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; contractType: NftContractType; tokenIds?: TokenId[] | undefined; }) | ({ type: ConditionType.ERC20_OWNERSHIP; amount: { value: string; asset: { contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; decimals: number; }; }; condition: ConditionComparisonOperator; }) | ({ type: ConditionType.EOA_OWNERSHIP; address: string & { __type__: "EvmAddress"; }; }) | ({ type: ConditionType.PROFILE_OWNERSHIP; profileId: string & { __type__: "ProfileId"; }; }) | ({ type: ConditionType.FOLLOW; follow: string & { __type__: "ProfileId"; }; }) | ({ type: ConditionType.COLLECT; publicationId: string & { __type__: "PublicationId"; }; thisPublication: boolean; })>>;
    encryptedPaths: string[];
    encryptionKey: string & {
        __type__: "LitEncryptionKey";
    };
    provider: LIT_PROTOCOL;
}
+

The publication encryption strategy.

+

This is normally populated by the Lens SDK so the vast majority of developers will not need to use this directly.

+
+
+

Type declaration

+
    +
  • +
    accessCondition: OrCondition<({ type: ConditionType.NFT_OWNERSHIP; contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; contractType: NftContractType; tokenIds?: TokenId[] | undefined; }) | ({ type: ConditionType.ERC20_OWNERSHIP; amount: { value: string; asset: { contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; decimals: number; }; }; condition: ConditionComparisonOperator; }) | ({ type: ConditionType.EOA_OWNERSHIP; address: string & { __type__: "EvmAddress"; }; }) | ({ type: ConditionType.PROFILE_OWNERSHIP; profileId: string & { __type__: "ProfileId"; }; }) | ({ type: ConditionType.FOLLOW; follow: string & { __type__: "ProfileId"; }; }) | ({ type: ConditionType.COLLECT; publicationId: string & { __type__: "PublicationId"; }; thisPublication: boolean; }) | AndCondition<({ type: ConditionType.NFT_OWNERSHIP; contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; contractType: NftContractType; tokenIds?: TokenId[] | undefined; }) | ({ type: ConditionType.ERC20_OWNERSHIP; amount: { value: string; asset: { contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; decimals: number; }; }; condition: ConditionComparisonOperator; }) | ({ type: ConditionType.EOA_OWNERSHIP; address: string & { __type__: "EvmAddress"; }; }) | ({ type: ConditionType.PROFILE_OWNERSHIP; profileId: string & { __type__: "ProfileId"; }; }) | ({ type: ConditionType.FOLLOW; follow: string & { __type__: "ProfileId"; }; }) | ({ type: ConditionType.COLLECT; publicationId: string & { __type__: "PublicationId"; }; thisPublication: boolean; })> | OrCondition<({ type: ConditionType.NFT_OWNERSHIP; contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; contractType: NftContractType; tokenIds?: TokenId[] | undefined; }) | ({ type: ConditionType.ERC20_OWNERSHIP; amount: { value: string; asset: { contract: { chainId: number & { __type__: "ChainId"; }; address: string & { __type__: "EvmAddress"; }; }; decimals: number; }; }; condition: ConditionComparisonOperator; }) | ({ type: ConditionType.EOA_OWNERSHIP; address: string & { __type__: "EvmAddress"; }; }) | ({ type: ConditionType.PROFILE_OWNERSHIP; profileId: string & { __type__: "ProfileId"; }; }) | ({ type: ConditionType.FOLLOW; follow: string & { __type__: "ProfileId"; }; }) | ({ type: ConditionType.COLLECT; publicationId: string & { __type__: "PublicationId"; }; thisPublication: boolean; })>>
    • +
  • +
    encryptedPaths: string[]
    • +
  • +
    encryptionKey: string & {
        __type__: "LitEncryptionKey";
    }
    • +
  • +
    provider: LIT_PROTOCOL
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/PublicationId-1.html b/docs/types/PublicationId-1.html new file mode 100644 index 0000000..952f60f --- /dev/null +++ b/docs/types/PublicationId-1.html @@ -0,0 +1,61 @@ +PublicationId | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias PublicationId

+
PublicationId: Brand<string, "PublicationId">
+

A publication identifier.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/PublicationMetadata.html b/docs/types/PublicationMetadata.html new file mode 100644 index 0000000..e4772cd --- /dev/null +++ b/docs/types/PublicationMetadata.html @@ -0,0 +1,376 @@ +PublicationMetadata | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias PublicationMetadata

+
PublicationMetadata: {
    $schema: THREE_D_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; assets: { format: ThreeDFormat; uri: string & { __type__: "URI"; }; playerUrl: string & { ...; }; zipPath?: string | undefined; license?: MetadataLicenseType | undefined; }[]; ... 8 more ...; attachments?: ({ ...; } | ......;
    name?: string;
    signature?: Signature;
} | {
    $schema: ARTICLE_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; content: (string | EncryptedString) & (string | EncryptedString | undefined); locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; ... 8 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
    name?: string;
    signature?: Signature;
} | {
    $schema: AUDIO_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; audio: { type: MediaAudioMimeType; item: (string | EncryptedString) & (string | ... 1 more ... | undefined); ... 9 more ...; lyrics?: string | ... 1 more ... | undefined; }; ... 9 more ...; attachments?: ({ ...; } | ... 1...;
    name?: string;
    signature?: Signature;
} | {
    $schema: CHECKING_IN_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; location: (string | EncryptedString) & (string | EncryptedString | undefined); ... 10 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
    name?: string;
    signature?: Signature;
} | {
    $schema: EMBED_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; embed: (string | EncryptedString) & (string | EncryptedString | undefined); ... 8 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
    name?: string;
    signature?: Signature;
} | {
    $schema: EVENT_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; location: (string | URI) & (string | URI | undefined); ... 14 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
    name?: string;
    signature?: Signature;
} | {
    $schema: IMAGE_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; image: { type: MediaImageMimeType; item: (string | EncryptedString) & (string | EncryptedString | undefined); attributes?: ({ ...; } | ... 3 more ... | { ...; })[] | undefined; altTag?: string | ... 1 more ... | undefined; license?: MetadataLicenseType | undefined; }; ... 11 more ...; attachments?: ({ ...;
    name?: string;
    signature?: Signature;
} | {
    $schema: LINK_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; sharingLink: (string | EncryptedString) & (string | ... 1 more ... | undefined); ... 8 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
    name?: string;
    signature?: Signature;
} | {
    $schema: LIVESTREAM_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; startsAt: (string | EncryptedString) & (string | EncryptedString | undefined); ... 13 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
    name?: string;
    signature?: Signature;
} | {
    $schema: MINT_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; mintLink: (string | EncryptedString) & (string | EncryptedString | undefined); ... 8 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
    name?: string;
    signature?: Signature;
} | {
    $schema: SPACE_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; link: (string | EncryptedString) & (string | EncryptedString | undefined); locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; ... 10 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
    name?: string;
    signature?: Signature;
} | {
    $schema: STORY_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; asset: { type: MediaAudioMimeType; item: (string | EncryptedString) & (string | EncryptedString | undefined); ... 9 more ...; lyrics?: string | ... 1 more ... | undefined; } | { ...; } | { ...; }; ... 9 more ...; contentWarning?: PublicationContentWarning | undefined; };
    name?: string;
    signature?: Signature;
} | {
    $schema: TEXT_ONLY_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; content: (string | EncryptedString) & (string | EncryptedString | undefined); locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; ... 6 more ...; contentWarning?: PublicationContentWarning | undefined; };
    name?: string;
    signature?: Signature;
} | {
    $schema: TRANSACTION_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; type: TransactionMetadataType; chainId: number; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; ... 9 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
    name?: string;
    signature?: Signature;
} | {
    $schema: VIDEO_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; video: { type: MediaVideoMimeType; item: (string | EncryptedString) & (string | ... 1 more ... | undefined); ... 4 more ...; license?: MetadataLicenseType | undefined; }; ... 9 more ...; attachments?: ({ ...; } | ... 1 mo...;
    name?: string;
    signature?: Signature;
}
+

The type of a publication metadata object.

+
+
+

Type declaration

+
    +
  • +
    $schema: THREE_D_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; assets: { format: ThreeDFormat; uri: string & { __type__: "URI"; }; playerUrl: string & { ...; }; zipPath?: string | undefined; license?: MetadataLicenseType | undefined; }[]; ... 8 more ...; attachments?: ({ ...; } | ......
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+

Type declaration

+
    +
  • +
    $schema: ARTICLE_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; content: (string | EncryptedString) & (string | EncryptedString | undefined); locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; ... 8 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; }
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+

Type declaration

+
    +
  • +
    $schema: AUDIO_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; audio: { type: MediaAudioMimeType; item: (string | EncryptedString) & (string | ... 1 more ... | undefined); ... 9 more ...; lyrics?: string | ... 1 more ... | undefined; }; ... 9 more ...; attachments?: ({ ...; } | ... 1...
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+

Type declaration

+
    +
  • +
    $schema: CHECKING_IN_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; location: (string | EncryptedString) & (string | EncryptedString | undefined); ... 10 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; }
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+

Type declaration

+
    +
  • +
    $schema: EMBED_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; embed: (string | EncryptedString) & (string | EncryptedString | undefined); ... 8 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; }
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+

Type declaration

+
    +
  • +
    $schema: EVENT_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; location: (string | URI) & (string | URI | undefined); ... 14 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; }
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+

Type declaration

+
    +
  • +
    $schema: IMAGE_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; image: { type: MediaImageMimeType; item: (string | EncryptedString) & (string | EncryptedString | undefined); attributes?: ({ ...; } | ... 3 more ... | { ...; })[] | undefined; altTag?: string | ... 1 more ... | undefined; license?: MetadataLicenseType | undefined; }; ... 11 more ...; attachments?: ({ ...
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+

Type declaration

+
    +
  • +
    $schema: LINK_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; sharingLink: (string | EncryptedString) & (string | ... 1 more ... | undefined); ... 8 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; }
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+

Type declaration

+
    +
  • +
    $schema: LIVESTREAM_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; startsAt: (string | EncryptedString) & (string | EncryptedString | undefined); ... 13 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; }
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+

Type declaration

+
    +
  • +
    $schema: MINT_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; mintLink: (string | EncryptedString) & (string | EncryptedString | undefined); ... 8 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; }
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+

Type declaration

+
    +
  • +
    $schema: SPACE_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; link: (string | EncryptedString) & (string | EncryptedString | undefined); locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; ... 10 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; }
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+

Type declaration

+
    +
  • +
    $schema: STORY_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; asset: { type: MediaAudioMimeType; item: (string | EncryptedString) & (string | EncryptedString | undefined); ... 9 more ...; lyrics?: string | ... 1 more ... | undefined; } | { ...; } | { ...; }; ... 9 more ...; contentWarning?: PublicationContentWarning | undefined; }
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+

Type declaration

+
    +
  • +
    $schema: TEXT_ONLY_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; content: (string | EncryptedString) & (string | EncryptedString | undefined); locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; ... 6 more ...; contentWarning?: PublicationContentWarning | undefined; }
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+

Type declaration

+
    +
  • +
    $schema: TRANSACTION_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; type: TransactionMetadataType; chainId: number; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; ... 9 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; }
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+

Type declaration

+
    +
  • +
    $schema: VIDEO_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; video: { type: MediaVideoMimeType; item: (string | EncryptedString) & (string | ... 1 more ... | undefined); ... 4 more ...; license?: MetadataLicenseType | undefined; }; ... 9 more ...; attachments?: ({ ...; } | ... 1 mo...
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/SchedulingAdjustments.html b/docs/types/SchedulingAdjustments.html new file mode 100644 index 0000000..cb7ca3c --- /dev/null +++ b/docs/types/SchedulingAdjustments.html @@ -0,0 +1,65 @@ +SchedulingAdjustments | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias SchedulingAdjustments

+
SchedulingAdjustments: {
    timezoneId: "Africa/Abidjan" | "Africa/Accra" | "Africa/Addis_Ababa" | "Africa/Algiers" | "Africa/Asmera" | "Africa/Bamako" | "Africa/Bangui" | "Africa/Banjul" | "Africa/Bissau" | "Africa/Blantyre" | "Africa/Brazzaville" | "Africa/Bujumbura" | "Africa/Cairo" | "Africa/Casablanca" | "Africa/Ceuta" | "Africa/Conakry" | "Africa/Dakar" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Douala" | "Africa/El_Aaiun" | "Africa/Freetown" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Johannesburg" | "Africa/Juba" | "Africa/Kampala" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Lome" | "Africa/Luanda" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Malabo" | "Africa/Maputo" | "Africa/Maseru" | "Africa/Mbabane" | "Africa/Mogadishu" | "Africa/Monrovia" | "Africa/Nairobi" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Africa/Porto-Novo" | "Africa/Sao_Tome" | "Africa/Tripoli" | "Africa/Tunis" | "Africa/Windhoek" | "America/Adak" | "America/Anchorage" | "America/Anguilla" | "America/Antigua" | "America/Araguaina" | "America/Argentina/La_Rioja" | "America/Argentina/Rio_Gallegos" | "America/Argentina/Salta" | "America/Argentina/San_Juan" | "America/Argentina/San_Luis" | "America/Argentina/Tucuman" | "America/Argentina/Ushuaia" | "America/Aruba" | "America/Asuncion" | "America/Bahia" | "America/Bahia_Banderas" | "America/Barbados" | "America/Belem" | "America/Belize" | "America/Blanc-Sablon" | "America/Boa_Vista" | "America/Bogota" | "America/Boise" | "America/Buenos_Aires" | "America/Cambridge_Bay" | "America/Campo_Grande" | "America/Cancun" | "America/Caracas" | "America/Catamarca" | "America/Cayenne" | "America/Cayman" | "America/Chicago" | "America/Chihuahua" | "America/Ciudad_Juarez" | "America/Coral_Harbour" | "America/Cordoba" | "America/Costa_Rica" | "America/Creston" | "America/Cuiaba" | "America/Curacao" | "America/Danmarkshavn" | "America/Dawson" | "America/Dawson_Creek" | "America/Denver" | "America/Detroit" | "America/Dominica" | "America/Edmonton" | "America/Eirunepe" | "America/El_Salvador" | "America/Fort_Nelson" | "America/Fortaleza" | "America/Glace_Bay" | "America/Godthab" | "America/Goose_Bay" | "America/Grand_Turk" | "America/Grenada" | "America/Guadeloupe" | "America/Guatemala" | "America/Guayaquil" | "America/Guyana" | "America/Halifax" | "America/Havana" | "America/Hermosillo" | "America/Indiana/Knox" | "America/Indiana/Marengo" | "America/Indiana/Petersburg" | "America/Indiana/Tell_City" | "America/Indiana/Vevay" | "America/Indiana/Vincennes" | "America/Indiana/Winamac" | "America/Indianapolis" | "America/Inuvik" | "America/Iqaluit" | "America/Jamaica" | "America/Jujuy" | "America/Juneau" | "America/Kentucky/Monticello" | "America/Kralendijk" | "America/La_Paz" | "America/Lima" | "America/Los_Angeles" | "America/Louisville" | "America/Lower_Princes" | "America/Maceio" | "America/Managua" | "America/Manaus" | "America/Marigot" | "America/Martinique" | "America/Matamoros" | "America/Mazatlan" | "America/Mendoza" | "America/Menominee" | "America/Merida" | "America/Metlakatla" | "America/Mexico_City" | "America/Miquelon" | "America/Moncton" | "America/Monterrey" | "America/Montevideo" | "America/Montserrat" | "America/Nassau" | "America/New_York" | "America/Nipigon" | "America/Nome" | "America/Noronha" | "America/North_Dakota/Beulah" | "America/North_Dakota/Center" | "America/North_Dakota/New_Salem" | "America/Ojinaga" | "America/Panama" | "America/Pangnirtung" | "America/Paramaribo" | "America/Phoenix" | "America/Port-au-Prince" | "America/Port_of_Spain" | "America/Porto_Velho" | "America/Puerto_Rico" | "America/Punta_Arenas" | "America/Rainy_River" | "America/Rankin_Inlet" | "America/Recife" | "America/Regina" | "America/Resolute" | "America/Rio_Branco" | "America/Santa_Isabel" | "America/Santarem" | "America/Santiago" | "America/Santo_Domingo" | "America/Sao_Paulo" | "America/Scoresbysund" | "America/Sitka" | "America/St_Barthelemy" | "America/St_Johns" | "America/St_Kitts" | "America/St_Lucia" | "America/St_Thomas" | "America/St_Vincent" | "America/Swift_Current" | "America/Tegucigalpa" | "America/Thule" | "America/Thunder_Bay" | "America/Tijuana" | "America/Toronto" | "America/Tortola" | "America/Vancouver" | "America/Whitehorse" | "America/Winnipeg" | "America/Yakutat" | "America/Yellowknife" | "Antarctica/Casey" | "Antarctica/Davis" | "Antarctica/DumontDUrville" | "Antarctica/Macquarie" | "Antarctica/Mawson" | "Antarctica/McMurdo" | "Antarctica/Palmer" | "Antarctica/Rothera" | "Antarctica/Syowa" | "Antarctica/Troll" | "Antarctica/Vostok" | "Arctic/Longyearbyen" | "Asia/Aden" | "Asia/Almaty" | "Asia/Amman" | "Asia/Anadyr" | "Asia/Aqtau" | "Asia/Aqtobe" | "Asia/Ashgabat" | "Asia/Atyrau" | "Asia/Baghdad" | "Asia/Bahrain" | "Asia/Baku" | "Asia/Bangkok" | "Asia/Barnaul" | "Asia/Beirut" | "Asia/Bishkek" | "Asia/Brunei" | "Asia/Calcutta" | "Asia/Chita" | "Asia/Choibalsan" | "Asia/Colombo" | "Asia/Damascus" | "Asia/Dhaka" | "Asia/Dili" | "Asia/Dubai" | "Asia/Dushanbe" | "Asia/Famagusta" | "Asia/Gaza" | "Asia/Hebron" | "Asia/Hong_Kong" | "Asia/Hovd" | "Asia/Irkutsk" | "Asia/Jakarta" | "Asia/Jayapura" | "Asia/Jerusalem" | "Asia/Kabul" | "Asia/Kamchatka" | "Asia/Karachi" | "Asia/Katmandu" | "Asia/Khandyga" | "Asia/Krasnoyarsk" | "Asia/Kuala_Lumpur" | "Asia/Kuching" | "Asia/Kuwait" | "Asia/Macau" | "Asia/Magadan" | "Asia/Makassar" | "Asia/Manila" | "Asia/Muscat" | "Asia/Nicosia" | "Asia/Novokuznetsk" | "Asia/Novosibirsk" | "Asia/Omsk" | "Asia/Oral" | "Asia/Phnom_Penh" | "Asia/Pontianak" | "Asia/Pyongyang" | "Asia/Qatar" | "Asia/Qostanay" | "Asia/Qyzylorda" | "Asia/Rangoon" | "Asia/Riyadh" | "Asia/Saigon" | "Asia/Sakhalin" | "Asia/Samarkand" | "Asia/Seoul" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Srednekolymsk" | "Asia/Taipei" | "Asia/Tashkent" | "Asia/Tbilisi" | "Asia/Tehran" | "Asia/Thimphu" | "Asia/Tokyo" | "Asia/Tomsk" | "Asia/Ulaanbaatar" | "Asia/Urumqi" | "Asia/Ust-Nera" | "Asia/Vientiane" | "Asia/Vladivostok" | "Asia/Yakutsk" | "Asia/Yekaterinburg" | "Asia/Yerevan" | "Atlantic/Azores" | "Atlantic/Bermuda" | "Atlantic/Canary" | "Atlantic/Cape_Verde" | "Atlantic/Faeroe" | "Atlantic/Madeira" | "Atlantic/Reykjavik" | "Atlantic/South_Georgia" | "Atlantic/St_Helena" | "Atlantic/Stanley" | "Australia/Adelaide" | "Australia/Brisbane" | "Australia/Broken_Hill" | "Australia/Currie" | "Australia/Darwin" | "Australia/Eucla" | "Australia/Hobart" | "Australia/Lindeman" | "Australia/Lord_Howe" | "Australia/Melbourne" | "Australia/Perth" | "Australia/Sydney" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Astrakhan" | "Europe/Athens" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Bucharest" | "Europe/Budapest" | "Europe/Busingen" | "Europe/Chisinau" | "Europe/Copenhagen" | "Europe/Dublin" | "Europe/Gibraltar" | "Europe/Guernsey" | "Europe/Helsinki" | "Europe/Isle_of_Man" | "Europe/Istanbul" | "Europe/Jersey" | "Europe/Kaliningrad" | "Europe/Kiev" | "Europe/Kirov" | "Europe/Lisbon" | "Europe/Ljubljana" | "Europe/London" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Malta" | "Europe/Mariehamn" | "Europe/Minsk" | "Europe/Monaco" | "Europe/Moscow" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Riga" | "Europe/Rome" | "Europe/Samara" | "Europe/San_Marino" | "Europe/Sarajevo" | "Europe/Saratov" | "Europe/Simferopol" | "Europe/Skopje" | "Europe/Sofia" | "Europe/Stockholm" | "Europe/Tallinn" | "Europe/Tirane" | "Europe/Ulyanovsk" | "Europe/Uzhgorod" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Vilnius" | "Europe/Volgograd" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zaporozhye" | "Europe/Zurich" | "Indian/Antananarivo" | "Indian/Chagos" | "Indian/Christmas" | "Indian/Cocos" | "Indian/Comoro" | "Indian/Kerguelen" | "Indian/Mahe" | "Indian/Maldives" | "Indian/Mauritius" | "Indian/Mayotte" | "Indian/Reunion" | "Pacific/Apia" | "Pacific/Auckland" | "Pacific/Bougainville" | "Pacific/Chatham" | "Pacific/Easter" | "Pacific/Efate" | "Pacific/Enderbury" | "Pacific/Fakaofo" | "Pacific/Fiji" | "Pacific/Funafuti" | "Pacific/Galapagos" | "Pacific/Gambier" | "Pacific/Guadalcanal" | "Pacific/Guam" | "Pacific/Honolulu" | "Pacific/Johnston" | "Pacific/Kiritimati" | "Pacific/Kosrae" | "Pacific/Kwajalein" | "Pacific/Majuro" | "Pacific/Marquesas" | "Pacific/Midway" | "Pacific/Nauru" | "Pacific/Niue" | "Pacific/Norfolk" | "Pacific/Noumea" | "Pacific/Pago_Pago" | "Pacific/Palau" | "Pacific/Pitcairn" | "Pacific/Ponape" | "Pacific/Port_Moresby" | "Pacific/Rarotonga" | "Pacific/Saipan" | "Pacific/Tahiti" | "Pacific/Tarawa" | "Pacific/Tongatapu" | "Pacific/Truk" | "Pacific/Wake" | "Pacific/Wallis";
    timezoneOffset: number;
}
+
+

Type declaration

+
    +
  • +
    timezoneId: "Africa/Abidjan" | "Africa/Accra" | "Africa/Addis_Ababa" | "Africa/Algiers" | "Africa/Asmera" | "Africa/Bamako" | "Africa/Bangui" | "Africa/Banjul" | "Africa/Bissau" | "Africa/Blantyre" | "Africa/Brazzaville" | "Africa/Bujumbura" | "Africa/Cairo" | "Africa/Casablanca" | "Africa/Ceuta" | "Africa/Conakry" | "Africa/Dakar" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Douala" | "Africa/El_Aaiun" | "Africa/Freetown" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Johannesburg" | "Africa/Juba" | "Africa/Kampala" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Lome" | "Africa/Luanda" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Malabo" | "Africa/Maputo" | "Africa/Maseru" | "Africa/Mbabane" | "Africa/Mogadishu" | "Africa/Monrovia" | "Africa/Nairobi" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Africa/Porto-Novo" | "Africa/Sao_Tome" | "Africa/Tripoli" | "Africa/Tunis" | "Africa/Windhoek" | "America/Adak" | "America/Anchorage" | "America/Anguilla" | "America/Antigua" | "America/Araguaina" | "America/Argentina/La_Rioja" | "America/Argentina/Rio_Gallegos" | "America/Argentina/Salta" | "America/Argentina/San_Juan" | "America/Argentina/San_Luis" | "America/Argentina/Tucuman" | "America/Argentina/Ushuaia" | "America/Aruba" | "America/Asuncion" | "America/Bahia" | "America/Bahia_Banderas" | "America/Barbados" | "America/Belem" | "America/Belize" | "America/Blanc-Sablon" | "America/Boa_Vista" | "America/Bogota" | "America/Boise" | "America/Buenos_Aires" | "America/Cambridge_Bay" | "America/Campo_Grande" | "America/Cancun" | "America/Caracas" | "America/Catamarca" | "America/Cayenne" | "America/Cayman" | "America/Chicago" | "America/Chihuahua" | "America/Ciudad_Juarez" | "America/Coral_Harbour" | "America/Cordoba" | "America/Costa_Rica" | "America/Creston" | "America/Cuiaba" | "America/Curacao" | "America/Danmarkshavn" | "America/Dawson" | "America/Dawson_Creek" | "America/Denver" | "America/Detroit" | "America/Dominica" | "America/Edmonton" | "America/Eirunepe" | "America/El_Salvador" | "America/Fort_Nelson" | "America/Fortaleza" | "America/Glace_Bay" | "America/Godthab" | "America/Goose_Bay" | "America/Grand_Turk" | "America/Grenada" | "America/Guadeloupe" | "America/Guatemala" | "America/Guayaquil" | "America/Guyana" | "America/Halifax" | "America/Havana" | "America/Hermosillo" | "America/Indiana/Knox" | "America/Indiana/Marengo" | "America/Indiana/Petersburg" | "America/Indiana/Tell_City" | "America/Indiana/Vevay" | "America/Indiana/Vincennes" | "America/Indiana/Winamac" | "America/Indianapolis" | "America/Inuvik" | "America/Iqaluit" | "America/Jamaica" | "America/Jujuy" | "America/Juneau" | "America/Kentucky/Monticello" | "America/Kralendijk" | "America/La_Paz" | "America/Lima" | "America/Los_Angeles" | "America/Louisville" | "America/Lower_Princes" | "America/Maceio" | "America/Managua" | "America/Manaus" | "America/Marigot" | "America/Martinique" | "America/Matamoros" | "America/Mazatlan" | "America/Mendoza" | "America/Menominee" | "America/Merida" | "America/Metlakatla" | "America/Mexico_City" | "America/Miquelon" | "America/Moncton" | "America/Monterrey" | "America/Montevideo" | "America/Montserrat" | "America/Nassau" | "America/New_York" | "America/Nipigon" | "America/Nome" | "America/Noronha" | "America/North_Dakota/Beulah" | "America/North_Dakota/Center" | "America/North_Dakota/New_Salem" | "America/Ojinaga" | "America/Panama" | "America/Pangnirtung" | "America/Paramaribo" | "America/Phoenix" | "America/Port-au-Prince" | "America/Port_of_Spain" | "America/Porto_Velho" | "America/Puerto_Rico" | "America/Punta_Arenas" | "America/Rainy_River" | "America/Rankin_Inlet" | "America/Recife" | "America/Regina" | "America/Resolute" | "America/Rio_Branco" | "America/Santa_Isabel" | "America/Santarem" | "America/Santiago" | "America/Santo_Domingo" | "America/Sao_Paulo" | "America/Scoresbysund" | "America/Sitka" | "America/St_Barthelemy" | "America/St_Johns" | "America/St_Kitts" | "America/St_Lucia" | "America/St_Thomas" | "America/St_Vincent" | "America/Swift_Current" | "America/Tegucigalpa" | "America/Thule" | "America/Thunder_Bay" | "America/Tijuana" | "America/Toronto" | "America/Tortola" | "America/Vancouver" | "America/Whitehorse" | "America/Winnipeg" | "America/Yakutat" | "America/Yellowknife" | "Antarctica/Casey" | "Antarctica/Davis" | "Antarctica/DumontDUrville" | "Antarctica/Macquarie" | "Antarctica/Mawson" | "Antarctica/McMurdo" | "Antarctica/Palmer" | "Antarctica/Rothera" | "Antarctica/Syowa" | "Antarctica/Troll" | "Antarctica/Vostok" | "Arctic/Longyearbyen" | "Asia/Aden" | "Asia/Almaty" | "Asia/Amman" | "Asia/Anadyr" | "Asia/Aqtau" | "Asia/Aqtobe" | "Asia/Ashgabat" | "Asia/Atyrau" | "Asia/Baghdad" | "Asia/Bahrain" | "Asia/Baku" | "Asia/Bangkok" | "Asia/Barnaul" | "Asia/Beirut" | "Asia/Bishkek" | "Asia/Brunei" | "Asia/Calcutta" | "Asia/Chita" | "Asia/Choibalsan" | "Asia/Colombo" | "Asia/Damascus" | "Asia/Dhaka" | "Asia/Dili" | "Asia/Dubai" | "Asia/Dushanbe" | "Asia/Famagusta" | "Asia/Gaza" | "Asia/Hebron" | "Asia/Hong_Kong" | "Asia/Hovd" | "Asia/Irkutsk" | "Asia/Jakarta" | "Asia/Jayapura" | "Asia/Jerusalem" | "Asia/Kabul" | "Asia/Kamchatka" | "Asia/Karachi" | "Asia/Katmandu" | "Asia/Khandyga" | "Asia/Krasnoyarsk" | "Asia/Kuala_Lumpur" | "Asia/Kuching" | "Asia/Kuwait" | "Asia/Macau" | "Asia/Magadan" | "Asia/Makassar" | "Asia/Manila" | "Asia/Muscat" | "Asia/Nicosia" | "Asia/Novokuznetsk" | "Asia/Novosibirsk" | "Asia/Omsk" | "Asia/Oral" | "Asia/Phnom_Penh" | "Asia/Pontianak" | "Asia/Pyongyang" | "Asia/Qatar" | "Asia/Qostanay" | "Asia/Qyzylorda" | "Asia/Rangoon" | "Asia/Riyadh" | "Asia/Saigon" | "Asia/Sakhalin" | "Asia/Samarkand" | "Asia/Seoul" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Srednekolymsk" | "Asia/Taipei" | "Asia/Tashkent" | "Asia/Tbilisi" | "Asia/Tehran" | "Asia/Thimphu" | "Asia/Tokyo" | "Asia/Tomsk" | "Asia/Ulaanbaatar" | "Asia/Urumqi" | "Asia/Ust-Nera" | "Asia/Vientiane" | "Asia/Vladivostok" | "Asia/Yakutsk" | "Asia/Yekaterinburg" | "Asia/Yerevan" | "Atlantic/Azores" | "Atlantic/Bermuda" | "Atlantic/Canary" | "Atlantic/Cape_Verde" | "Atlantic/Faeroe" | "Atlantic/Madeira" | "Atlantic/Reykjavik" | "Atlantic/South_Georgia" | "Atlantic/St_Helena" | "Atlantic/Stanley" | "Australia/Adelaide" | "Australia/Brisbane" | "Australia/Broken_Hill" | "Australia/Currie" | "Australia/Darwin" | "Australia/Eucla" | "Australia/Hobart" | "Australia/Lindeman" | "Australia/Lord_Howe" | "Australia/Melbourne" | "Australia/Perth" | "Australia/Sydney" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Astrakhan" | "Europe/Athens" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Bucharest" | "Europe/Budapest" | "Europe/Busingen" | "Europe/Chisinau" | "Europe/Copenhagen" | "Europe/Dublin" | "Europe/Gibraltar" | "Europe/Guernsey" | "Europe/Helsinki" | "Europe/Isle_of_Man" | "Europe/Istanbul" | "Europe/Jersey" | "Europe/Kaliningrad" | "Europe/Kiev" | "Europe/Kirov" | "Europe/Lisbon" | "Europe/Ljubljana" | "Europe/London" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Malta" | "Europe/Mariehamn" | "Europe/Minsk" | "Europe/Monaco" | "Europe/Moscow" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Riga" | "Europe/Rome" | "Europe/Samara" | "Europe/San_Marino" | "Europe/Sarajevo" | "Europe/Saratov" | "Europe/Simferopol" | "Europe/Skopje" | "Europe/Sofia" | "Europe/Stockholm" | "Europe/Tallinn" | "Europe/Tirane" | "Europe/Ulyanovsk" | "Europe/Uzhgorod" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Vilnius" | "Europe/Volgograd" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zaporozhye" | "Europe/Zurich" | "Indian/Antananarivo" | "Indian/Chagos" | "Indian/Christmas" | "Indian/Cocos" | "Indian/Comoro" | "Indian/Kerguelen" | "Indian/Mahe" | "Indian/Maldives" | "Indian/Mauritius" | "Indian/Mayotte" | "Indian/Reunion" | "Pacific/Apia" | "Pacific/Auckland" | "Pacific/Bougainville" | "Pacific/Chatham" | "Pacific/Easter" | "Pacific/Efate" | "Pacific/Enderbury" | "Pacific/Fakaofo" | "Pacific/Fiji" | "Pacific/Funafuti" | "Pacific/Galapagos" | "Pacific/Gambier" | "Pacific/Guadalcanal" | "Pacific/Guam" | "Pacific/Honolulu" | "Pacific/Johnston" | "Pacific/Kiritimati" | "Pacific/Kosrae" | "Pacific/Kwajalein" | "Pacific/Majuro" | "Pacific/Marquesas" | "Pacific/Midway" | "Pacific/Nauru" | "Pacific/Niue" | "Pacific/Norfolk" | "Pacific/Noumea" | "Pacific/Pago_Pago" | "Pacific/Palau" | "Pacific/Pitcairn" | "Pacific/Ponape" | "Pacific/Port_Moresby" | "Pacific/Rarotonga" | "Pacific/Saipan" | "Pacific/Tahiti" | "Pacific/Tarawa" | "Pacific/Tongatapu" | "Pacific/Truk" | "Pacific/Wake" | "Pacific/Wallis"
    • +
  • +
    timezoneOffset: number
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/Signature-10.html b/docs/types/Signature-10.html new file mode 100644 index 0000000..90f48db --- /dev/null +++ b/docs/types/Signature-10.html @@ -0,0 +1,61 @@ +Signature | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias Signature

+
Signature: Brand<string, "Signature">
+

A cryptographic signature.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/SimpleCondition.html b/docs/types/SimpleCondition.html new file mode 100644 index 0000000..18d9628 --- /dev/null +++ b/docs/types/SimpleCondition.html @@ -0,0 +1,58 @@ +SimpleCondition | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias SimpleCondition

+
SimpleCondition: CollectCondition | EoaOwnershipCondition | Erc20OwnershipCondition | FollowCondition | NftOwnershipCondition | ProfileOwnershipCondition
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/SpaceMetadata.html b/docs/types/SpaceMetadata.html new file mode 100644 index 0000000..87c4ed2 --- /dev/null +++ b/docs/types/SpaceMetadata.html @@ -0,0 +1,79 @@ +SpaceMetadata | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias SpaceMetadata

+
SpaceMetadata: {
    $schema: SPACE_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; link: (string | EncryptedString) & (string | EncryptedString | undefined); locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; ... 10 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
    name?: string;
    signature?: Signature;
}
+
+

Type declaration

+
    +
  • +
    $schema: SPACE_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; link: (string | EncryptedString) & (string | EncryptedString | undefined); locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; ... 10 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; }
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/SpaceOptions.html b/docs/types/SpaceOptions.html new file mode 100644 index 0000000..55043d3 --- /dev/null +++ b/docs/types/SpaceOptions.html @@ -0,0 +1,59 @@ +SpaceOptions | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias SpaceOptions

+
SpaceOptions: PublicationMetadataOptions<SpaceMetadata>
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/StoryMetadata.html b/docs/types/StoryMetadata.html new file mode 100644 index 0000000..fa15fda --- /dev/null +++ b/docs/types/StoryMetadata.html @@ -0,0 +1,79 @@ +StoryMetadata | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias StoryMetadata

+
StoryMetadata: {
    $schema: STORY_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; asset: { type: MediaAudioMimeType; item: (string | EncryptedString) & (string | EncryptedString | undefined); ... 9 more ...; lyrics?: string | ... 1 more ... | undefined; } | { ...; } | { ...; }; ... 9 more ...; contentWarning?: PublicationContentWarning | undefined; };
    name?: string;
    signature?: Signature;
}
+
+

Type declaration

+
    +
  • +
    $schema: STORY_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; asset: { type: MediaAudioMimeType; item: (string | EncryptedString) & (string | EncryptedString | undefined); ... 9 more ...; lyrics?: string | ... 1 more ... | undefined; } | { ...; } | { ...; }; ... 9 more ...; contentWarning?: PublicationContentWarning | undefined; }
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/StoryOptions.html b/docs/types/StoryOptions.html new file mode 100644 index 0000000..95bac19 --- /dev/null +++ b/docs/types/StoryOptions.html @@ -0,0 +1,59 @@ +StoryOptions | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias StoryOptions

+
StoryOptions: PublicationMetadataOptions<StoryMetadata>
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/StringAttribute.html b/docs/types/StringAttribute.html new file mode 100644 index 0000000..2f2f3bb --- /dev/null +++ b/docs/types/StringAttribute.html @@ -0,0 +1,67 @@ +StringAttribute | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias StringAttribute

+
StringAttribute: {
    key: string;
    type: STRING;
    value: string;
}
+
+

Type declaration

+
    +
  • +
    key: string
    • +
  • +
    type: STRING
    • +
  • +
    value: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/Tag.html b/docs/types/Tag.html new file mode 100644 index 0000000..5ea59ca --- /dev/null +++ b/docs/types/Tag.html @@ -0,0 +1,61 @@ +Tag | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias Tag

+
Tag: Brand<string, "Tag">
+

An arbitrary tag.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/TextOnlyMetadata.html b/docs/types/TextOnlyMetadata.html new file mode 100644 index 0000000..e3424b5 --- /dev/null +++ b/docs/types/TextOnlyMetadata.html @@ -0,0 +1,79 @@ +TextOnlyMetadata | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias TextOnlyMetadata

+
TextOnlyMetadata: {
    $schema: TEXT_ONLY_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; content: (string | EncryptedString) & (string | EncryptedString | undefined); locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; ... 6 more ...; contentWarning?: PublicationContentWarning | undefined; };
    name?: string;
    signature?: Signature;
}
+
+

Type declaration

+
    +
  • +
    $schema: TEXT_ONLY_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; content: (string | EncryptedString) & (string | EncryptedString | undefined); locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; ... 6 more ...; contentWarning?: PublicationContentWarning | undefined; }
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/TextOnlyOptions.html b/docs/types/TextOnlyOptions.html new file mode 100644 index 0000000..5e98256 --- /dev/null +++ b/docs/types/TextOnlyOptions.html @@ -0,0 +1,59 @@ +TextOnlyOptions | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias TextOnlyOptions

+
TextOnlyOptions: PublicationMetadataOptions<TextOnlyMetadata>
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/ThreeDAsset.html b/docs/types/ThreeDAsset.html new file mode 100644 index 0000000..b088be5 --- /dev/null +++ b/docs/types/ThreeDAsset.html @@ -0,0 +1,71 @@ +ThreeDAsset | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias ThreeDAsset

+
ThreeDAsset: {
    format: ThreeDFormat;
    license?: CCO | CC_BY | CC_BY_ND | CC_BY_NC | TBNL_C_D_PL_Legal | TBNL_C_DT_PL_Legal | TBNL_C_ND_PL_Legal | TBNL_C_D_NPL_Legal | TBNL_C_DT_NPL_Legal | TBNL_C_DTSA_PL_Legal | TBNL_C_DTSA_NPL_Legal | TBNL_C_ND_NPL_Legal | TBNL_C_D_PL_Ledger | TBNL_C_DT_PL_Ledger | TBNL_C_ND_PL_Ledger | TBNL_C_D_NPL_Ledger | TBNL_C_DT_NPL_Ledger | TBNL_C_DTSA_PL_Ledger | TBNL_C_DTSA_NPL_Ledger | TBNL_C_ND_NPL_Ledger | TBNL_NC_D_PL_Legal | TBNL_NC_DT_PL_Legal | TBNL_NC_ND_PL_Legal | TBNL_NC_D_NPL_Legal | TBNL_NC_DT_NPL_Legal | TBNL_NC_DTSA_PL_Legal | TBNL_NC_DTSA_NPL_Legal | TBNL_NC_ND_NPL_Legal | TBNL_NC_D_PL_Ledger | TBNL_NC_DT_PL_Ledger | TBNL_NC_ND_PL_Ledger | TBNL_NC_D_NPL_Ledger | TBNL_NC_DT_NPL_Ledger | TBNL_NC_DTSA_PL_Ledger | TBNL_NC_DTSA_NPL_Ledger | TBNL_NC_ND_NPL_Ledger;
    playerUrl: string & {
        __type__: "URI";
    };
    uri: string & {
        __type__: "URI";
    };
    zipPath?: string;
}
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/ThreeDMetadata.html b/docs/types/ThreeDMetadata.html new file mode 100644 index 0000000..394fb00 --- /dev/null +++ b/docs/types/ThreeDMetadata.html @@ -0,0 +1,79 @@ +ThreeDMetadata | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias ThreeDMetadata

+
ThreeDMetadata: {
    $schema: THREE_D_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; assets: { format: ThreeDFormat; uri: string & { __type__: "URI"; }; playerUrl: string & { ...; }; zipPath?: string | undefined; license?: MetadataLicenseType | undefined; }[]; ... 8 more ...; attachments?: ({ ...; } | ......;
    name?: string;
    signature?: Signature;
}
+
+

Type declaration

+
    +
  • +
    $schema: THREE_D_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; assets: { format: ThreeDFormat; uri: string & { __type__: "URI"; }; playerUrl: string & { ...; }; zipPath?: string | undefined; license?: MetadataLicenseType | undefined; }[]; ... 8 more ...; attachments?: ({ ...; } | ......
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/ThreeDOptions.html b/docs/types/ThreeDOptions.html new file mode 100644 index 0000000..271eb56 --- /dev/null +++ b/docs/types/ThreeDOptions.html @@ -0,0 +1,59 @@ +ThreeDOptions | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias ThreeDOptions

+
ThreeDOptions: PublicationMetadataOptions<ThreeDMetadata>
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/TimezoneId-1.html b/docs/types/TimezoneId-1.html new file mode 100644 index 0000000..278dab2 --- /dev/null +++ b/docs/types/TimezoneId-1.html @@ -0,0 +1,58 @@ +TimezoneId | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias TimezoneId

+
TimezoneId: "Africa/Abidjan" | "Africa/Accra" | "Africa/Addis_Ababa" | "Africa/Algiers" | "Africa/Asmera" | "Africa/Bamako" | "Africa/Bangui" | "Africa/Banjul" | "Africa/Bissau" | "Africa/Blantyre" | "Africa/Brazzaville" | "Africa/Bujumbura" | "Africa/Cairo" | "Africa/Casablanca" | "Africa/Ceuta" | "Africa/Conakry" | "Africa/Dakar" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Douala" | "Africa/El_Aaiun" | "Africa/Freetown" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Johannesburg" | "Africa/Juba" | "Africa/Kampala" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Lome" | "Africa/Luanda" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Malabo" | "Africa/Maputo" | "Africa/Maseru" | "Africa/Mbabane" | "Africa/Mogadishu" | "Africa/Monrovia" | "Africa/Nairobi" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Africa/Porto-Novo" | "Africa/Sao_Tome" | "Africa/Tripoli" | "Africa/Tunis" | "Africa/Windhoek" | "America/Adak" | "America/Anchorage" | "America/Anguilla" | "America/Antigua" | "America/Araguaina" | "America/Argentina/La_Rioja" | "America/Argentina/Rio_Gallegos" | "America/Argentina/Salta" | "America/Argentina/San_Juan" | "America/Argentina/San_Luis" | "America/Argentina/Tucuman" | "America/Argentina/Ushuaia" | "America/Aruba" | "America/Asuncion" | "America/Bahia" | "America/Bahia_Banderas" | "America/Barbados" | "America/Belem" | "America/Belize" | "America/Blanc-Sablon" | "America/Boa_Vista" | "America/Bogota" | "America/Boise" | "America/Buenos_Aires" | "America/Cambridge_Bay" | "America/Campo_Grande" | "America/Cancun" | "America/Caracas" | "America/Catamarca" | "America/Cayenne" | "America/Cayman" | "America/Chicago" | "America/Chihuahua" | "America/Ciudad_Juarez" | "America/Coral_Harbour" | "America/Cordoba" | "America/Costa_Rica" | "America/Creston" | "America/Cuiaba" | "America/Curacao" | "America/Danmarkshavn" | "America/Dawson" | "America/Dawson_Creek" | "America/Denver" | "America/Detroit" | "America/Dominica" | "America/Edmonton" | "America/Eirunepe" | "America/El_Salvador" | "America/Fort_Nelson" | "America/Fortaleza" | "America/Glace_Bay" | "America/Godthab" | "America/Goose_Bay" | "America/Grand_Turk" | "America/Grenada" | "America/Guadeloupe" | "America/Guatemala" | "America/Guayaquil" | "America/Guyana" | "America/Halifax" | "America/Havana" | "America/Hermosillo" | "America/Indiana/Knox" | "America/Indiana/Marengo" | "America/Indiana/Petersburg" | "America/Indiana/Tell_City" | "America/Indiana/Vevay" | "America/Indiana/Vincennes" | "America/Indiana/Winamac" | "America/Indianapolis" | "America/Inuvik" | "America/Iqaluit" | "America/Jamaica" | "America/Jujuy" | "America/Juneau" | "America/Kentucky/Monticello" | "America/Kralendijk" | "America/La_Paz" | "America/Lima" | "America/Los_Angeles" | "America/Louisville" | "America/Lower_Princes" | "America/Maceio" | "America/Managua" | "America/Manaus" | "America/Marigot" | "America/Martinique" | "America/Matamoros" | "America/Mazatlan" | "America/Mendoza" | "America/Menominee" | "America/Merida" | "America/Metlakatla" | "America/Mexico_City" | "America/Miquelon" | "America/Moncton" | "America/Monterrey" | "America/Montevideo" | "America/Montserrat" | "America/Nassau" | "America/New_York" | "America/Nipigon" | "America/Nome" | "America/Noronha" | "America/North_Dakota/Beulah" | "America/North_Dakota/Center" | "America/North_Dakota/New_Salem" | "America/Ojinaga" | "America/Panama" | "America/Pangnirtung" | "America/Paramaribo" | "America/Phoenix" | "America/Port-au-Prince" | "America/Port_of_Spain" | "America/Porto_Velho" | "America/Puerto_Rico" | "America/Punta_Arenas" | "America/Rainy_River" | "America/Rankin_Inlet" | "America/Recife" | "America/Regina" | "America/Resolute" | "America/Rio_Branco" | "America/Santa_Isabel" | "America/Santarem" | "America/Santiago" | "America/Santo_Domingo" | "America/Sao_Paulo" | "America/Scoresbysund" | "America/Sitka" | "America/St_Barthelemy" | "America/St_Johns" | "America/St_Kitts" | "America/St_Lucia" | "America/St_Thomas" | "America/St_Vincent" | "America/Swift_Current" | "America/Tegucigalpa" | "America/Thule" | "America/Thunder_Bay" | "America/Tijuana" | "America/Toronto" | "America/Tortola" | "America/Vancouver" | "America/Whitehorse" | "America/Winnipeg" | "America/Yakutat" | "America/Yellowknife" | "Antarctica/Casey" | "Antarctica/Davis" | "Antarctica/DumontDUrville" | "Antarctica/Macquarie" | "Antarctica/Mawson" | "Antarctica/McMurdo" | "Antarctica/Palmer" | "Antarctica/Rothera" | "Antarctica/Syowa" | "Antarctica/Troll" | "Antarctica/Vostok" | "Arctic/Longyearbyen" | "Asia/Aden" | "Asia/Almaty" | "Asia/Amman" | "Asia/Anadyr" | "Asia/Aqtau" | "Asia/Aqtobe" | "Asia/Ashgabat" | "Asia/Atyrau" | "Asia/Baghdad" | "Asia/Bahrain" | "Asia/Baku" | "Asia/Bangkok" | "Asia/Barnaul" | "Asia/Beirut" | "Asia/Bishkek" | "Asia/Brunei" | "Asia/Calcutta" | "Asia/Chita" | "Asia/Choibalsan" | "Asia/Colombo" | "Asia/Damascus" | "Asia/Dhaka" | "Asia/Dili" | "Asia/Dubai" | "Asia/Dushanbe" | "Asia/Famagusta" | "Asia/Gaza" | "Asia/Hebron" | "Asia/Hong_Kong" | "Asia/Hovd" | "Asia/Irkutsk" | "Asia/Jakarta" | "Asia/Jayapura" | "Asia/Jerusalem" | "Asia/Kabul" | "Asia/Kamchatka" | "Asia/Karachi" | "Asia/Katmandu" | "Asia/Khandyga" | "Asia/Krasnoyarsk" | "Asia/Kuala_Lumpur" | "Asia/Kuching" | "Asia/Kuwait" | "Asia/Macau" | "Asia/Magadan" | "Asia/Makassar" | "Asia/Manila" | "Asia/Muscat" | "Asia/Nicosia" | "Asia/Novokuznetsk" | "Asia/Novosibirsk" | "Asia/Omsk" | "Asia/Oral" | "Asia/Phnom_Penh" | "Asia/Pontianak" | "Asia/Pyongyang" | "Asia/Qatar" | "Asia/Qostanay" | "Asia/Qyzylorda" | "Asia/Rangoon" | "Asia/Riyadh" | "Asia/Saigon" | "Asia/Sakhalin" | "Asia/Samarkand" | "Asia/Seoul" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Srednekolymsk" | "Asia/Taipei" | "Asia/Tashkent" | "Asia/Tbilisi" | "Asia/Tehran" | "Asia/Thimphu" | "Asia/Tokyo" | "Asia/Tomsk" | "Asia/Ulaanbaatar" | "Asia/Urumqi" | "Asia/Ust-Nera" | "Asia/Vientiane" | "Asia/Vladivostok" | "Asia/Yakutsk" | "Asia/Yekaterinburg" | "Asia/Yerevan" | "Atlantic/Azores" | "Atlantic/Bermuda" | "Atlantic/Canary" | "Atlantic/Cape_Verde" | "Atlantic/Faeroe" | "Atlantic/Madeira" | "Atlantic/Reykjavik" | "Atlantic/South_Georgia" | "Atlantic/St_Helena" | "Atlantic/Stanley" | "Australia/Adelaide" | "Australia/Brisbane" | "Australia/Broken_Hill" | "Australia/Currie" | "Australia/Darwin" | "Australia/Eucla" | "Australia/Hobart" | "Australia/Lindeman" | "Australia/Lord_Howe" | "Australia/Melbourne" | "Australia/Perth" | "Australia/Sydney" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Astrakhan" | "Europe/Athens" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Bucharest" | "Europe/Budapest" | "Europe/Busingen" | "Europe/Chisinau" | "Europe/Copenhagen" | "Europe/Dublin" | "Europe/Gibraltar" | "Europe/Guernsey" | "Europe/Helsinki" | "Europe/Isle_of_Man" | "Europe/Istanbul" | "Europe/Jersey" | "Europe/Kaliningrad" | "Europe/Kiev" | "Europe/Kirov" | "Europe/Lisbon" | "Europe/Ljubljana" | "Europe/London" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Malta" | "Europe/Mariehamn" | "Europe/Minsk" | "Europe/Monaco" | "Europe/Moscow" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Riga" | "Europe/Rome" | "Europe/Samara" | "Europe/San_Marino" | "Europe/Sarajevo" | "Europe/Saratov" | "Europe/Simferopol" | "Europe/Skopje" | "Europe/Sofia" | "Europe/Stockholm" | "Europe/Tallinn" | "Europe/Tirane" | "Europe/Ulyanovsk" | "Europe/Uzhgorod" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Vilnius" | "Europe/Volgograd" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zaporozhye" | "Europe/Zurich" | "Indian/Antananarivo" | "Indian/Chagos" | "Indian/Christmas" | "Indian/Cocos" | "Indian/Comoro" | "Indian/Kerguelen" | "Indian/Mahe" | "Indian/Maldives" | "Indian/Mauritius" | "Indian/Mayotte" | "Indian/Reunion" | "Pacific/Apia" | "Pacific/Auckland" | "Pacific/Bougainville" | "Pacific/Chatham" | "Pacific/Easter" | "Pacific/Efate" | "Pacific/Enderbury" | "Pacific/Fakaofo" | "Pacific/Fiji" | "Pacific/Funafuti" | "Pacific/Galapagos" | "Pacific/Gambier" | "Pacific/Guadalcanal" | "Pacific/Guam" | "Pacific/Honolulu" | "Pacific/Johnston" | "Pacific/Kiritimati" | "Pacific/Kosrae" | "Pacific/Kwajalein" | "Pacific/Majuro" | "Pacific/Marquesas" | "Pacific/Midway" | "Pacific/Nauru" | "Pacific/Niue" | "Pacific/Norfolk" | "Pacific/Noumea" | "Pacific/Pago_Pago" | "Pacific/Palau" | "Pacific/Pitcairn" | "Pacific/Ponape" | "Pacific/Port_Moresby" | "Pacific/Rarotonga" | "Pacific/Saipan" | "Pacific/Tahiti" | "Pacific/Tarawa" | "Pacific/Tongatapu" | "Pacific/Truk" | "Pacific/Wake" | "Pacific/Wallis"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/TokenId.html b/docs/types/TokenId.html new file mode 100644 index 0000000..304bc90 --- /dev/null +++ b/docs/types/TokenId.html @@ -0,0 +1,61 @@ +TokenId | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias TokenId

+
TokenId: Brand<string, "TokenId">
+

An NFT token identifier.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/TransactionMetadata.html b/docs/types/TransactionMetadata.html new file mode 100644 index 0000000..1e4f278 --- /dev/null +++ b/docs/types/TransactionMetadata.html @@ -0,0 +1,79 @@ +TransactionMetadata | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias TransactionMetadata

+
TransactionMetadata: {
    $schema: TRANSACTION_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; type: TransactionMetadataType; chainId: number; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; ... 9 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; };
    name?: string;
    signature?: Signature;
}
+
+

Type declaration

+
    +
  • +
    $schema: TRANSACTION_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; type: TransactionMetadataType; chainId: number; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; ... 9 more ...; attachments?: ({ ...; } | ... 1 more ... | { ...; })[] | undefined; }
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/TransactionOptions.html b/docs/types/TransactionOptions.html new file mode 100644 index 0000000..b38d388 --- /dev/null +++ b/docs/types/TransactionOptions.html @@ -0,0 +1,59 @@ +TransactionOptions | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias TransactionOptions

+
TransactionOptions: PublicationMetadataOptions<TransactionMetadata>
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/TwoAtLeastArray.html b/docs/types/TwoAtLeastArray.html new file mode 100644 index 0000000..b9e9f6d --- /dev/null +++ b/docs/types/TwoAtLeastArray.html @@ -0,0 +1,66 @@ +TwoAtLeastArray | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias TwoAtLeastArray<T>

+
TwoAtLeastArray<T>: [T, T, ...T[]]
+

Declares an array of at least two elements of the specified type.

+
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/URI-1.html b/docs/types/URI-1.html new file mode 100644 index 0000000..ce9e208 --- /dev/null +++ b/docs/types/URI-1.html @@ -0,0 +1,63 @@ +URI | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias URI

+
URI: Brand<string, "URI">
+

A Uniform Resource Identifier.

+

It could be a URL pointing to a specific resource, +an IPFS URI (e.g. ipfs://Qm...), or an Arweave URI (e.g. ar://Qm...).

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/VideoMetadata.html b/docs/types/VideoMetadata.html new file mode 100644 index 0000000..6fe2333 --- /dev/null +++ b/docs/types/VideoMetadata.html @@ -0,0 +1,79 @@ +VideoMetadata | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias VideoMetadata

+
VideoMetadata: {
    $schema: VIDEO_LATEST;
    animation_url?: URI;
    attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[];
    description?: Markdown;
    external_url?: URI;
    image?: URI;
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; video: { type: MediaVideoMimeType; item: (string | EncryptedString) & (string | ... 1 more ... | undefined); ... 4 more ...; license?: MetadataLicenseType | undefined; }; ... 9 more ...; attachments?: ({ ...; } | ... 1 mo...;
    name?: string;
    signature?: Signature;
}
+
+

Type declaration

+
    +
  • +
    $schema: VIDEO_LATEST
    • +
  • +
    Optional animation_url?: URI
    • +
  • +
    Optional attributes?: {
        displayType?: NUMBER | STRING | DATE;
        traitType?: string;
        value: string;
    }[]
    • +
  • +
    Optional description?: Markdown
    • +
  • +
    Optional external_url?: URI
    • +
  • +
    Optional image?: URI
    • +
  • +
    lens: { id: string; locale: string & { __type__: "Locale"; }; mainContentFocus: PublicationMainFocus; video: { type: MediaVideoMimeType; item: (string | EncryptedString) & (string | ... 1 more ... | undefined); ... 4 more ...; license?: MetadataLicenseType | undefined; }; ... 9 more ...; attachments?: ({ ...; } | ... 1 mo...
    • +
  • +
    Optional name?: string
    • +
  • +
    Optional signature?: Signature
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/types/VideoOptions.html b/docs/types/VideoOptions.html new file mode 100644 index 0000000..b248ea0 --- /dev/null +++ b/docs/types/VideoOptions.html @@ -0,0 +1,59 @@ +VideoOptions | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Type alias VideoOptions

+
VideoOptions: PublicationMetadataOptions<VideoMetadata>
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/variables/AnyMediaSchema.html b/docs/variables/AnyMediaSchema.html new file mode 100644 index 0000000..b919afb --- /dev/null +++ b/docs/variables/AnyMediaSchema.html @@ -0,0 +1,58 @@ +AnyMediaSchema | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Variable AnyMediaSchemaConst

+
AnyMediaSchema: ZodDiscriminatedUnion<AnyMedia> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/variables/BooleanAttributeSchema.html b/docs/variables/BooleanAttributeSchema.html new file mode 100644 index 0000000..c26e8b0 --- /dev/null +++ b/docs/variables/BooleanAttributeSchema.html @@ -0,0 +1,58 @@ +BooleanAttributeSchema | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Variable BooleanAttributeSchemaConst

+
BooleanAttributeSchema: ZodObject<BooleanAttribute> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/variables/DateAttributeSchema.html b/docs/variables/DateAttributeSchema.html new file mode 100644 index 0000000..5d2eec8 --- /dev/null +++ b/docs/variables/DateAttributeSchema.html @@ -0,0 +1,58 @@ +DateAttributeSchema | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Variable DateAttributeSchemaConst

+
DateAttributeSchema: ZodObject<DateAttribute> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/variables/JSONAttributeSchema.html b/docs/variables/JSONAttributeSchema.html new file mode 100644 index 0000000..592ed94 --- /dev/null +++ b/docs/variables/JSONAttributeSchema.html @@ -0,0 +1,58 @@ +JSONAttributeSchema | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Variable JSONAttributeSchemaConst

+
JSONAttributeSchema: ZodObject<JSONAttribute> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/variables/MarketplaceMetadataAttributeSchema.html b/docs/variables/MarketplaceMetadataAttributeSchema.html new file mode 100644 index 0000000..d32df2f --- /dev/null +++ b/docs/variables/MarketplaceMetadataAttributeSchema.html @@ -0,0 +1,58 @@ +MarketplaceMetadataAttributeSchema | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Variable MarketplaceMetadataAttributeSchemaConst

+
MarketplaceMetadataAttributeSchema: ZodObject<MarketplaceMetadataAttribute> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/variables/MarketplaceMetadataSchema.html b/docs/variables/MarketplaceMetadataSchema.html new file mode 100644 index 0000000..49818ae --- /dev/null +++ b/docs/variables/MarketplaceMetadataSchema.html @@ -0,0 +1,58 @@ +MarketplaceMetadataSchema | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Variable MarketplaceMetadataSchemaConst

+
MarketplaceMetadataSchema: ZodObject<MarketplaceMetadata> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/variables/MediaAudioSchema.html b/docs/variables/MediaAudioSchema.html new file mode 100644 index 0000000..096b9a7 --- /dev/null +++ b/docs/variables/MediaAudioSchema.html @@ -0,0 +1,58 @@ +MediaAudioSchema | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Variable MediaAudioSchemaConst

+
MediaAudioSchema: ZodObject<MediaAudio> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/variables/MediaImageSchema.html b/docs/variables/MediaImageSchema.html new file mode 100644 index 0000000..c984949 --- /dev/null +++ b/docs/variables/MediaImageSchema.html @@ -0,0 +1,58 @@ +MediaImageSchema | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Variable MediaImageSchemaConst

+
MediaImageSchema: ZodObject<MediaImage> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/variables/MediaVideoSchema.html b/docs/variables/MediaVideoSchema.html new file mode 100644 index 0000000..f69ab78 --- /dev/null +++ b/docs/variables/MediaVideoSchema.html @@ -0,0 +1,58 @@ +MediaVideoSchema | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Variable MediaVideoSchemaConst

+
MediaVideoSchema: ZodObject<MediaVideo> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/variables/MetadataAttributeSchema.html b/docs/variables/MetadataAttributeSchema.html new file mode 100644 index 0000000..d48ab38 --- /dev/null +++ b/docs/variables/MetadataAttributeSchema.html @@ -0,0 +1,58 @@ +MetadataAttributeSchema | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Variable MetadataAttributeSchemaConst

+
MetadataAttributeSchema: ZodDiscriminatedUnion<MetadataAttribute> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/variables/MetadataLicenseTypeSchema.html b/docs/variables/MetadataLicenseTypeSchema.html new file mode 100644 index 0000000..ee33877 --- /dev/null +++ b/docs/variables/MetadataLicenseTypeSchema.html @@ -0,0 +1,58 @@ +MetadataLicenseTypeSchema | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Variable MetadataLicenseTypeSchemaConst

+
MetadataLicenseTypeSchema: ZodNativeEnum<typeof MetadataLicenseType> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/variables/MirrorMetadataSchema.html b/docs/variables/MirrorMetadataSchema.html new file mode 100644 index 0000000..aab96e9 --- /dev/null +++ b/docs/variables/MirrorMetadataSchema.html @@ -0,0 +1,69 @@ +MirrorMetadataSchema | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Variable MirrorMetadataSchemaConst

+
MirrorMetadataSchema: ZodObject<MirrorMetadata> = ...
+

Mirror metadata schema.

+
+
+

Example

with parse:

+
MirrorMetadata.parse(valid); // => MirrorMetadata

MirrorMetadata.parse(invalid); // => throws ZodError
+
+ +

Example

with safeParse:

+
MirrorMetadata.safeParse(valid);
// => { success: true, data: MirrorMetadata }

MirrorMetadata.safeParse(invalid);
// => { success: false, error: ZodError }
+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/variables/NumberAttributeSchema.html b/docs/variables/NumberAttributeSchema.html new file mode 100644 index 0000000..50801d4 --- /dev/null +++ b/docs/variables/NumberAttributeSchema.html @@ -0,0 +1,58 @@ +NumberAttributeSchema | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Variable NumberAttributeSchemaConst

+
NumberAttributeSchema: ZodObject<NumberAttribute> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/variables/ProfileMetadataSchema.html b/docs/variables/ProfileMetadataSchema.html new file mode 100644 index 0000000..adf0a89 --- /dev/null +++ b/docs/variables/ProfileMetadataSchema.html @@ -0,0 +1,69 @@ +ProfileMetadataSchema | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Variable ProfileMetadataSchemaConst

+
ProfileMetadataSchema: ZodObject<ProfileMetadata> = ...
+

Profile Metadata schema.

+
+
+

Example

with parse:

+
ProfileMetadataSchema.parse(valid); // => ProfileMetadata

ProfileMetadataSchema.parse(invalid); // => throws ZodError
+
+ +

Example

with safeParse:

+
ProfileMetadataSchema.safeParse(valid);
// => { success: true, data: ProfileMetadata }

ProfileMetadataSchema.safeParse(invalid);
// => { success: false, error: ZodError }
+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/variables/PublicationMetadataSchema.html b/docs/variables/PublicationMetadataSchema.html new file mode 100644 index 0000000..a02ed5a --- /dev/null +++ b/docs/variables/PublicationMetadataSchema.html @@ -0,0 +1,69 @@ +PublicationMetadataSchema | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Variable PublicationMetadataSchemaConst

+
PublicationMetadataSchema: ZodDiscriminatedUnion<PublicationMetadata> = ...
+

A union of all publication metadata schemas.

+
+
+

Example

with parse:

+
PublicationMetadataSchema.parse(valid); // => PublicationMetadata

PublicationMetadataSchema.parse(invalid); // => throws ZodError
+
+ +

Example

with safeParse:

+
PublicationMetadataSchema.safeParse(valid);
// => { success: true, data: PublicationMetadata }

PublicationMetadataSchema.safeParse(invalid);
// => { success: false, error: ZodError }
+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/variables/StringAttributeSchema.html b/docs/variables/StringAttributeSchema.html new file mode 100644 index 0000000..1b84f20 --- /dev/null +++ b/docs/variables/StringAttributeSchema.html @@ -0,0 +1,58 @@ +StringAttributeSchema | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Variable StringAttributeSchemaConst

+
StringAttributeSchema: ZodObject<StringAttribute> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/variables/ThreeDSchema.html b/docs/variables/ThreeDSchema.html new file mode 100644 index 0000000..5970969 --- /dev/null +++ b/docs/variables/ThreeDSchema.html @@ -0,0 +1,58 @@ +ThreeDSchema | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Variable ThreeDSchemaConst

+
ThreeDSchema: ZodObject<ThreeDMetadata> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/variables/TimezoneIdSchema.html b/docs/variables/TimezoneIdSchema.html new file mode 100644 index 0000000..bb9e351 --- /dev/null +++ b/docs/variables/TimezoneIdSchema.html @@ -0,0 +1,58 @@ +TimezoneIdSchema | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Variable TimezoneIdSchemaConst

+
TimezoneIdSchema: ZodEnum<TimezoneId> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/docs/variables/timezones.html b/docs/variables/timezones.html new file mode 100644 index 0000000..e11079a --- /dev/null +++ b/docs/variables/timezones.html @@ -0,0 +1,58 @@ +timezones | Lens Protocol Metadata Standards
+
+ +
+
+
+
+ +

Variable timezonesConst

+
timezones: readonly ["Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/La_Rioja", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Ciudad_Juarez", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Fort_Nelson", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Monticello", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Colombo", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Hebron", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Katmandu", "Asia/Khandyga", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ulaanbaatar", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/Perth", "Australia/Sydney", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis"] = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/package.json b/package.json index e483ce2..512c426 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,9 @@ "lint:eslint": "pnpm eslint", "lint:typecheck": "tsc --noEmit", "lint:prettier": "prettier --check .", - "test": "jest" + "test": "jest", + "typedoc": "typedoc", + "typedoc:verbose": "typedoc --logLevel Verbose" }, "files": [ "dist", @@ -79,6 +81,8 @@ "ts-jest": "^29.1.1", "ts-node": "^10.9.1", "tsup": "^7.2.0", + "typedoc": "^0.25.1", + "typedoc-plugin-zod": "^1.1.0", "typescript": "^5.1.6", "zod": "^3.22.0", "zod-to-json-schema": "^3.21.4", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 45e6e11..15401d8 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -66,6 +66,12 @@ devDependencies: tsup: specifier: ^7.2.0 version: 7.2.0(ts-node@10.9.1)(typescript@5.1.6) + typedoc: + specifier: ^0.25.1 + version: 0.25.1(typescript@5.1.6) + typedoc-plugin-zod: + specifier: ^1.1.0 + version: 1.1.0(typedoc@0.25.1) typescript: specifier: ^5.1.6 version: 5.1.6 @@ -1550,6 +1556,10 @@ packages: engines: {node: '>=12'} dev: true + /ansi-sequence-parser@1.1.1: + resolution: {integrity: sha512-vJXt3yiaUL4UU546s3rPXlsry/RnM730G1+HkpKE012AN0sx1eOrxSu95oKDIonskeLTijMgqWZ3uDEe3NFvyg==} + dev: true + /ansi-styles@3.2.1: resolution: {integrity: sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==} engines: {node: '>=4'} @@ -3628,6 +3638,10 @@ packages: hasBin: true dev: true + /jsonc-parser@3.2.0: + resolution: {integrity: sha512-gfFQZrcTc8CnKXp6Y4/CBT3fTc0OVuDofpre4aEeEpSBPV5X5v4+Vmx+8snU7RLPrNHPKSgLxGo9YuQzz20o+w==} + dev: true + /jsonfile@4.0.0: resolution: {integrity: sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg==} optionalDependencies: @@ -3749,6 +3763,10 @@ packages: yallist: 4.0.0 dev: true + /lunr@2.3.9: + resolution: {integrity: sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==} + dev: true + /make-dir@4.0.0: resolution: {integrity: sha512-hXdUTZYIVOt1Ex//jAQi+wTZZpUpwBj/0QsOzqegb3rGMMeJiSEu5xLHnYfBrRV4RH2+OCSOO95Is/7x1WJ4bw==} engines: {node: '>=10'} @@ -3776,6 +3794,12 @@ packages: engines: {node: '>=8'} dev: true + /marked@4.3.0: + resolution: {integrity: sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==} + engines: {node: '>= 12'} + hasBin: true + dev: true + /meow@6.1.1: resolution: {integrity: sha512-3YffViIt2QWgTy6Pale5QpopX/IvU3LPL03jOTqp6pGj3VjesdO/U8CuHMKpnQr4shCNCM5fd5XFFvIIl6JBHg==} engines: {node: '>=8'} @@ -4399,6 +4423,15 @@ packages: engines: {node: '>=8'} dev: true + /shiki@0.14.4: + resolution: {integrity: sha512-IXCRip2IQzKwxArNNq1S+On4KPML3Yyn8Zzs/xRgcgOWIr8ntIK3IKzjFPfjy/7kt9ZMjc+FItfqHRBg8b6tNQ==} + dependencies: + ansi-sequence-parser: 1.1.1 + jsonc-parser: 3.2.0 + vscode-oniguruma: 1.7.0 + vscode-textmate: 8.0.0 + dev: true + /side-channel@1.0.4: resolution: {integrity: sha512-q5XPytqFEIKHkGdiMIrY10mvLRvnQh42/+GoBlFW3b2LXLE2xxJpZFdm94we0BaoV3RwJyGqg5wS7epxTv0Zvw==} dependencies: @@ -4916,6 +4949,28 @@ packages: is-typed-array: 1.1.12 dev: true + /typedoc-plugin-zod@1.1.0(typedoc@0.25.1): + resolution: {integrity: sha512-LaQdkYyVVL8CX+4R0GJuOyDa1meiG3M85FiBTPvlikCGaRkTNGSEBZTbx3gQHAsNQ5NWJpLvYJQB6gMhcO8bWw==} + peerDependencies: + typedoc: 0.23.x || 0.24.x || 0.25.x + dependencies: + typedoc: 0.25.1(typescript@5.1.6) + dev: true + + /typedoc@0.25.1(typescript@5.1.6): + resolution: {integrity: sha512-c2ye3YUtGIadxN2O6YwPEXgrZcvhlZ6HlhWZ8jQRNzwLPn2ylhdGqdR8HbyDRyALP8J6lmSANILCkkIdNPFxqA==} + engines: {node: '>= 16'} + hasBin: true + peerDependencies: + typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x + dependencies: + lunr: 2.3.9 + marked: 4.3.0 + minimatch: 9.0.3 + shiki: 0.14.4 + typescript: 5.1.6 + dev: true + /typescript@5.1.6: resolution: {integrity: sha512-zaWCozRZ6DLEWAWFrVDz1H6FVXzUSfTy5FUMWsQlU8Ym5JP9eO4xkTIROFCQvhQf61z6O/G6ugw3SgAnvvm+HA==} engines: {node: '>=14.17'} @@ -4983,6 +5038,14 @@ packages: spdx-expression-parse: 3.0.1 dev: true + /vscode-oniguruma@1.7.0: + resolution: {integrity: sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA==} + dev: true + + /vscode-textmate@8.0.0: + resolution: {integrity: sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg==} + dev: true + /walker@1.0.8: resolution: {integrity: sha512-ts/8E8l5b7kY0vlWLewOkDXMmPdLcVV4GmOQLyxuSswIJsweeFZtAsMF7k1Nszz+TYBQrlYRmzOnr398y1JemQ==} dependencies: diff --git a/src/builders.ts b/src/builders.ts index 8d499fc..4f0fbc3 100644 --- a/src/builders.ts +++ b/src/builders.ts @@ -48,19 +48,34 @@ export class ValidationError extends Error { name = 'ValidationError' as const; } -type BrandOf = [A] extends [Brand] ? R : never; +/** + * @internal + */ +export type BrandOf = [A] extends [Brand] ? R : never; -type UnbrandAll = T extends Brand> +/** + * @internal + */ +export type UnbrandAll = T extends Brand> ? R : { [K in keyof T]: UnbrandAll; }; -type ExtractLensSpec = T['lens']; +/** + * @internal + */ +export type ExtractLensSpec = T['lens']; -type OmitInferredPublicationFields = Omit; +/** + * @internal + */ +export type OmitInferredPublicationFields = Omit; -type PublicationDefaults
> = Overwrite< +/** + * @internal + */ +export type PublicationDefaults
> = Overwrite< Details, { /** @@ -84,7 +99,10 @@ type PublicationDefaults
> = } >; -type PublicationMetadataOptions< +/** + * @internal + */ +export type PublicationMetadataOptions< Metadata extends PublicationMetadata, Details extends ExtractLensSpec = ExtractLensSpec, > = Prettify< @@ -100,11 +118,15 @@ function process(result: z.SafeParseReturnType): O throw new ValidationError(formatZodError(result.error)); } +/** + * @category Compose + */ export type ArticleOptions = PublicationMetadataOptions; /** * Creates a valid ArticleMetadata. * - * @param args - {@link ArticleOptions} + * @category Compose + * @param input - {@link ArticleOptions} */ export function article({ marketplace, @@ -126,11 +148,15 @@ export function article({ ); } +/** + * @category Compose + */ export type AudioOptions = PublicationMetadataOptions; /** * Creates a valid AudioMetadata. * - * @param args - {@link AudioOptions} + * @category Compose + * @param input - {@link AudioOptions} */ export function audio({ marketplace, @@ -152,11 +178,15 @@ export function audio({ ); } +/** + * @category Compose + */ export type CheckingInOptions = PublicationMetadataOptions; /** * Creates a valid CheckingInMetadata. * - * @param args - {@link CheckingInOptions} + * @category Compose + * @param input - {@link CheckingInOptions} */ export function checkingIn({ marketplace, @@ -178,11 +208,15 @@ export function checkingIn({ ); } +/** + * @category Compose + */ export type EmbedOptions = PublicationMetadataOptions; /** * Creates a valid EmbedMetadata. * - * @param args - {@link EmbedOptions} + * @category Compose + * @param input - {@link EmbedOptions} */ export function embed({ marketplace, @@ -204,11 +238,15 @@ export function embed({ ); } +/** + * @category Compose + */ export type EventOptions = PublicationMetadataOptions; /** * Creates a valid EventMetadata. * - * @param args - {@link EventOptions} + * @category Compose + * @param input - {@link EventOptions} */ export function event({ marketplace, @@ -230,11 +268,15 @@ export function event({ ); } +/** + * @category Compose + */ export type ImageOptions = PublicationMetadataOptions; /** * Creates a valid ImageMetadata. * - * @param args - {@link ImageOptions} + * @category Compose + * @param input - {@link ImageOptions} */ export function image({ marketplace, @@ -256,11 +298,15 @@ export function image({ ); } +/** + * @category Compose + */ export type LinkOptions = PublicationMetadataOptions; /** * Creates a valid LinkMetadata. * - * @param args - {@link LinkOptions} + * @category Compose + * @param input - {@link LinkOptions} */ export function link({ marketplace, @@ -282,11 +328,15 @@ export function link({ ); } +/** + * @category Compose + */ export type LivestreamOptions = PublicationMetadataOptions; /** * Creates a valid LivestreamMetadata. * - * @param args - {@link LivestreamOptions} + * @category Compose + * @param input - {@link LivestreamOptions} */ export function livestream({ marketplace, @@ -308,11 +358,15 @@ export function livestream({ ); } +/** + * @category Compose + */ export type MintOptions = PublicationMetadataOptions; /** * Creates a valid MintMetadata. * - * @param args - {@link MintOptions} + * @category Compose + * @param input - {@link MintOptions} */ export function mint({ marketplace, @@ -334,11 +388,15 @@ export function mint({ ); } +/** + * @category Compose + */ export type SpaceOptions = PublicationMetadataOptions; /** * Creates a valid SpaceMetadata. * - * @param args - {@link SpaceOptions} + * @category Compose + * @param input - {@link SpaceOptions} */ export function space({ marketplace, @@ -360,11 +418,15 @@ export function space({ ); } +/** + * @category Compose + */ export type StoryOptions = PublicationMetadataOptions; /** * Creates a valid StoryMetadata. * - * @param args - {@link StoryOptions} + * @category Compose + * @param input - {@link StoryOptions} */ export function story({ marketplace, @@ -386,11 +448,15 @@ export function story({ ); } +/** + * @category Compose + */ export type TextOnlyOptions = PublicationMetadataOptions; /** * Creates a valid TextOnlyMetadata. * - * @param args - {@link TextOnlyOptions} + * @category Compose + * @param input - {@link TextOnlyOptions} */ export function textOnly({ marketplace, @@ -412,11 +478,15 @@ export function textOnly({ ); } +/** + * @category Compose + */ export type ThreeDOptions = PublicationMetadataOptions; /** * Creates a valid ThreeDMetadata. * - * @param args - {@link ThreeDOptions} + * @category Compose + * @param input - {@link ThreeDOptions} */ export function threeD({ marketplace, @@ -438,11 +508,15 @@ export function threeD({ ); } +/** + * @category Compose + */ export type TransactionOptions = PublicationMetadataOptions; /** * Creates a valid TransactionMetadata. * - * @param args - {@link TransactionOptions} + * @category Compose + * @param input - {@link TransactionOptions} */ export function transaction({ marketplace, @@ -464,11 +538,15 @@ export function transaction({ ); } +/** + * @category Compose + */ export type VideoOptions = PublicationMetadataOptions; /** * Creates a valid VideoMetadata. * - * @param args - {@link VideoOptions} + * @category Compose + * @param input - {@link VideoOptions} */ export function video({ marketplace, @@ -490,6 +568,9 @@ export function video({ ); } +/** + * @category Compose + */ export type MirrorOptions = Prettify< UnbrandAll< Overwrite< @@ -508,7 +589,8 @@ export type MirrorOptions = Prettify< /** * Creates a valid MirrorMetadata. * - * @param args - {@link MirrorOptions} + * @category Compose + * @param input - {@link MirrorOptions} */ export function mirror({ id = v4(), ...others }: MirrorOptions): MirrorMetadata { return process( @@ -522,6 +604,9 @@ export function mirror({ id = v4(), ...others }: MirrorOptions): MirrorMetadata ); } +/** + * @category Compose + */ export type ProfileOptions = Prettify< UnbrandAll< Overwrite< @@ -540,7 +625,8 @@ export type ProfileOptions = Prettify< /** * Creates a valid ProfileMetadata. * - * @param args - {@link ProfileOptions} + * @category Compose + * @param input - {@link ProfileOptions} */ export function profile({ id = v4(), ...others }: ProfileOptions): ProfileMetadata { return process( diff --git a/src/index.ts b/src/index.ts index e81b606..474c196 100644 --- a/src/index.ts +++ b/src/index.ts @@ -5,5 +5,5 @@ export * from './MetadataAttribute.js'; export * from './primitives.js'; export * from './profile/index.js'; export * from './publication/index.js'; -export type { Brand, TwoAtLeastArray } from './utils.js'; +export type { Brand, DistributiveOmit, Overwrite, Prettify, TwoAtLeastArray } from './utils.js'; export { extractVersion } from './utils.js'; diff --git a/src/legacy/profile.ts b/src/legacy/profile.ts index b5d19ca..756f039 100644 --- a/src/legacy/profile.ts +++ b/src/legacy/profile.ts @@ -35,6 +35,8 @@ export type ProfileMetadataAttribute = z.infer; /** * Helper to create a Geo URI from a {@link GeoPoint}. + * + * @category Compose */ export function geoUri(point: GeoPoint): GeoURI { const result = GeoPointSchema.safeParse(point); @@ -279,7 +284,9 @@ export function geoUri(point: GeoPoint): GeoURI { } /** - * Helper to extract a {@link GeoPoint} from a Geo URI. + * Helper to parse a {@link GeoPoint} from a {@link GeoURI}. + * + * @category Parse */ export function geoPoint(value: GeoURI): GeoPoint { const uri = GeoURISchema.parse(value); @@ -420,7 +427,9 @@ export const AssetSchema = z.object({ */ export type Asset = z.infer; /** - * @internal + * Creates an {@link Asset}. + * + * @category Compose */ export function asset(contract: NetworkAddress, decimals: number): Asset { return { contract, decimals }; diff --git a/src/profile/ProfileMetadataSchema.ts b/src/profile/ProfileMetadataSchema.ts index 45e2724..99ab092 100644 --- a/src/profile/ProfileMetadataSchema.ts +++ b/src/profile/ProfileMetadataSchema.ts @@ -47,6 +47,8 @@ export type ProfileMetadataDetails = z.infer = z.ZodObject< +/** + * @internal + */ +export type ComposableConditionSchema = z.ZodObject< { type: z.ZodTypeAny; } & z.ZodRawShape, diff --git a/src/publication/index.ts b/src/publication/index.ts index 1f1e219..de26da8 100644 --- a/src/publication/index.ts +++ b/src/publication/index.ts @@ -40,6 +40,8 @@ import { VideoSchema } from './VideoSchema.js'; /** * A union of all publication metadata schemas. * + * @category Parse + * * @example * with `parse`: * ```typescript diff --git a/tsdoc.json b/tsdoc.json new file mode 100644 index 0000000..b89839c --- /dev/null +++ b/tsdoc.json @@ -0,0 +1,4 @@ +{ + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "extends": ["typedoc/tsdoc.json"] +} diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 0000000..f09b952 --- /dev/null +++ b/typedoc.json @@ -0,0 +1,20 @@ +{ + "$schema": "https://typedoc.org/schema.json", + "entryPoints": ["./src/index.ts"], + "entryPointStrategy": "resolve", + "excludeExternals": true, + "excludeInternal": true, + "excludeNotDocumented": false, + "excludePrivate": true, + "excludeProtected": true, + "gitRevision": "main", + "hideGenerator": true, + "name": "Lens Protocol Metadata Standards", + "out": "docs", + "readme": "./README.md", + "categoryOrder": ["Compose", "Parse", "Other"], + "plugin": ["typedoc-plugin-zod"], + "disableSources": false, + "treatWarningsAsErrors": false, + "intentionallyNotExported": [] +} From c3643a1c09ffd4fe943bfc68be880a99db923a28 Mon Sep 17 00:00:00 2001 From: Cesare Naldi Date: Thu, 14 Sep 2023 23:58:51 +0200 Subject: [PATCH 2/3] Bumps up version --- .changeset/pre.json | 1 + CHANGELOG.md | 6 ++++++ package.json | 2 +- 3 files changed, 8 insertions(+), 1 deletion(-) diff --git a/.changeset/pre.json b/.changeset/pre.json index 5cb01cf..dcfbe6e 100644 --- a/.changeset/pre.json +++ b/.changeset/pre.json @@ -31,6 +31,7 @@ "shy-falcons-sip", "shy-parrots-approve", "six-camels-leave", + "swift-days-wash", "three-lamps-develop", "tiny-glasses-unite", "two-pigs-do" diff --git a/CHANGELOG.md b/CHANGELOG.md index c8be1f2..f91cf3b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # @lens-protocol/metadata +## 0.1.0-alpha.17 + +### Patch Changes + +- 8d1f2b1: **Added** docs generated with typedocs + ## 0.1.0-alpha.16 ### Patch Changes diff --git a/package.json b/package.json index 512c426..2dc9c83 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@lens-protocol/metadata", - "version": "0.1.0-alpha.16", + "version": "0.1.0-alpha.17", "description": "Lens Protocol Metadata Standards", "type": "module", "main": "./dist/index.cjs", From 0cd897ce09074245eb660598c0f25f54b74796d9 Mon Sep 17 00:00:00 2001 From: Cesare Naldi Date: Fri, 15 Sep 2023 00:02:00 +0200 Subject: [PATCH 3/3] prettier ignore docs --- .prettierignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.prettierignore b/.prettierignore index 801ca8d..a6c7cef 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,4 +1,5 @@ dist +docs jsonschemas pnpm-lock.yaml .changeset