Skip to content

Commit 9b18f33

Browse files
ChrisLallyChrisLally
committed
release: 0.0.0-alpha.6
1 parent 806f17a commit 9b18f33

27 files changed

Lines changed: 1252 additions & 633 deletions

‎docs/sdk/javascript/build-statement.mdx‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎docs/sdk/javascript/calculate-fide-id.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ full: true
99

1010
import { SDKFunctionPageInteractive } from '@/components/sdk-layout/sdk-function-page-interactive';
1111

12-
<SDKFunctionPageInteractive data={{"name":"calculateFideId","description":"Core primitive: calculate a Fide ID from type codes and reference identifier.\n\nDeterministic SHA-256 hash of the reference identifier (UTF-8), then constructs\n`did:fide:0x` + 2 hex (entity type) + 2 hex (reference type) + first 36 hex of hash = 40 hex total.","section":"@Fide Work","signatures":[{"description":"Core primitive: calculate a Fide ID from type codes and reference identifier.\n\nDeterministic SHA-256 hash of the reference identifier (UTF-8), then constructs\n`did:fide:0x` + 2 hex (entity type) + 2 hex (reference type) + first 36 hex of hash = 40 hex total.","parameters":[{"name":"entityType","type":"FideEntityType","optional":false,"description":"The entity type.","example":"Person","options":["Statement","Person","Organization","SoftwareAgent","NetworkResource","PlatformAccount","CryptographicAccount","CreativeWork","Concept","Place","Event","Action","PhysicalObject","TextLiteral","IntegerLiteral","DecimalLiteral","BoolLiteral","DateLiteral","TimeLiteral","DateTimeLiteral","DurationLiteral","URILiteral","JSONLiteral"]},{"name":"referenceType","type":"FideEntityType","optional":false,"description":"The reference type.","example":"NetworkResource","options":["Statement","Person","Organization","SoftwareAgent","NetworkResource","PlatformAccount","CryptographicAccount","CreativeWork","Concept","Place","Event","Action","PhysicalObject","TextLiteral","IntegerLiteral","DecimalLiteral","BoolLiteral","DateLiteral","TimeLiteral","DateTimeLiteral","DurationLiteral","URILiteral","JSONLiteral"]},{"name":"referenceIdentifier","type":"string","optional":false,"description":"The reference identifier string to hash (UTF-8 encoded).","example":"https://x.com/alice"},{"name":"options","type":"FideIdCalculationOptions","optional":true,"description":""}],"returnType":"Promise<`did:fide:0x${string}`>","returnDescription":"Promise resolving to the calculated Fide ID with format `did:fide:0x{entityTypeCode}{referenceTypeCode}{fingerprint}`","infoCallout":{"title":"Node Runtime Required","body":"This function requires a Node.js runtime and is disabled in the browser docs preview."},"referencedTypes":[{"name":"FideEntityType","description":"Valid Fide entity type names derived from `FIDE_ENTITY_TYPE_MAP`.","type":"\"Statement\" | \"Person\" | \"Organization\" | \"SoftwareAgent\" | \"NetworkResource\" | \"PlatformAccount\" | \"CryptographicAccount\" | \"CreativeWork\" | \"Concept\" | \"Place\" | \"Event\" | \"Action\" | \"PhysicalObject\" | \"TextLiteral\" | \"IntegerLiteral\" | \"DecimalLiteral\" | \"BoolLiteral\" | \"DateLiteral\" | \"TimeLiteral\" | \"DateTimeLiteral\" | \"DurationLiteral\" | \"URILiteral\" | \"JSONLiteral\"","docsUrl":"/vocabulary"},{"name":"FideIdCalculationOptions","description":"Options for Fide ID calculation helpers.\n\nReserved for forward-compatible toggles without changing function signatures.","type":"FideIdCalculationOptions","entries":{"dangerouslySkipReferenceTypePolicy":{"description":"If true, skip reference-type policy enforcement in calculateFideId.\nDefault is false (policy enforced).","type":"boolean","required":false},"dangerouslySkipReferenceIdentifierPolicy":{"description":"If true, skip referenceIdentifier policy enforcement in calculateFideId.\nDefault is false (policy enforced).","type":"boolean","required":false}}}]}],"constants":[],"referencedTypes":[{"name":"FideEntityType","description":"Valid Fide entity type names derived from `FIDE_ENTITY_TYPE_MAP`.","type":"\"Statement\" | \"Person\" | \"Organization\" | \"SoftwareAgent\" | \"NetworkResource\" | \"PlatformAccount\" | \"CryptographicAccount\" | \"CreativeWork\" | \"Concept\" | \"Place\" | \"Event\" | \"Action\" | \"PhysicalObject\" | \"TextLiteral\" | \"IntegerLiteral\" | \"DecimalLiteral\" | \"BoolLiteral\" | \"DateLiteral\" | \"TimeLiteral\" | \"DateTimeLiteral\" | \"DurationLiteral\" | \"URILiteral\" | \"JSONLiteral\"","docsUrl":"/vocabulary"},{"name":"FideIdCalculationOptions","description":"Options for Fide ID calculation helpers.\n\nReserved for forward-compatible toggles without changing function signatures.","type":"FideIdCalculationOptions","entries":{"dangerouslySkipReferenceTypePolicy":{"description":"If true, skip reference-type policy enforcement in calculateFideId.\nDefault is false (policy enforced).","type":"boolean","required":false},"dangerouslySkipReferenceIdentifierPolicy":{"description":"If true, skip referenceIdentifier policy enforcement in calculateFideId.\nDefault is false (policy enforced).","type":"boolean","required":false}}}]}} />
12+
<SDKFunctionPageInteractive data={{"name":"calculateFideId","description":"Core primitive: calculate a Fide ID from type codes and reference identifier.\n\nDeterministic SHA-256 hash of the reference identifier (UTF-8), then constructs\n`did:fide:0x` + 2 hex (entity type) + 2 hex (reference type) + first 36 hex of hash = 40 hex total.","section":"@Fide Work","signatures":[{"description":"Core primitive: calculate a Fide ID from type codes and reference identifier.\n\nDeterministic SHA-256 hash of the reference identifier (UTF-8), then constructs\n`did:fide:0x` + 2 hex (entity type) + 2 hex (reference type) + first 36 hex of hash = 40 hex total.","parameters":[{"name":"entityType","type":"FideEntityType","optional":false,"description":"The entity type.","example":"Person","options":["Statement","Person","Organization","SoftwareAgent","NetworkResource","PlatformAccount","CryptographicAccount","CreativeWork","Concept","Place","Event","Action","PhysicalObject","TextLiteral","IntegerLiteral","DecimalLiteral","BoolLiteral","DateLiteral","YearMonthLiteral","YearLiteral","TimeLiteral","DateTimeLiteral","DurationLiteral","URILiteral","JSONLiteral"]},{"name":"referenceType","type":"FideEntityType","optional":false,"description":"The reference type.","example":"NetworkResource","options":["Statement","Person","Organization","SoftwareAgent","NetworkResource","PlatformAccount","CryptographicAccount","CreativeWork","Concept","Place","Event","Action","PhysicalObject","TextLiteral","IntegerLiteral","DecimalLiteral","BoolLiteral","DateLiteral","YearMonthLiteral","YearLiteral","TimeLiteral","DateTimeLiteral","DurationLiteral","URILiteral","JSONLiteral"]},{"name":"referenceIdentifier","type":"string","optional":false,"description":"The reference identifier string to hash (UTF-8 encoded).","example":"https://x.com/alice"},{"name":"options","type":"FideIdCalculationOptions","optional":true,"description":""}],"returnType":"Promise<`did:fide:0x${string}`>","returnDescription":"Promise resolving to the calculated Fide ID with format `did:fide:0x{entityTypeCode}{referenceTypeCode}{fingerprint}`","infoCallout":{"title":"Node Runtime Required","body":"This function requires a Node.js runtime and is disabled in the browser docs preview."},"referencedTypes":[{"name":"FideEntityType","description":"Valid Fide entity type names derived from `FIDE_ENTITY_TYPE_MAP`.","type":"\"Statement\" | \"Person\" | \"Organization\" | \"SoftwareAgent\" | \"NetworkResource\" | \"PlatformAccount\" | \"CryptographicAccount\" | \"CreativeWork\" | \"Concept\" | \"Place\" | \"Event\" | \"Action\" | \"PhysicalObject\" | \"TextLiteral\" | \"IntegerLiteral\" | \"DecimalLiteral\" | \"BoolLiteral\" | \"DateLiteral\" | \"YearMonthLiteral\" | \"YearLiteral\" | \"TimeLiteral\" | \"DateTimeLiteral\" | \"DurationLiteral\" | \"URILiteral\" | \"JSONLiteral\"","docsUrl":"/vocabulary"},{"name":"FideIdCalculationOptions","description":"Options for Fide ID calculation helpers.\n\nReserved for forward-compatible toggles without changing function signatures.","type":"FideIdCalculationOptions","entries":{"dangerouslySkipReferenceTypePolicy":{"description":"If true, skip reference-type policy enforcement in calculateFideId.\nDefault is false (policy enforced).","type":"boolean","required":false},"dangerouslySkipReferenceIdentifierPolicy":{"description":"If true, skip referenceIdentifier policy enforcement in calculateFideId.\nDefault is false (policy enforced).","type":"boolean","required":false}}}]}],"constants":[],"referencedTypes":[{"name":"FideEntityType","description":"Valid Fide entity type names derived from `FIDE_ENTITY_TYPE_MAP`.","type":"\"Statement\" | \"Person\" | \"Organization\" | \"SoftwareAgent\" | \"NetworkResource\" | \"PlatformAccount\" | \"CryptographicAccount\" | \"CreativeWork\" | \"Concept\" | \"Place\" | \"Event\" | \"Action\" | \"PhysicalObject\" | \"TextLiteral\" | \"IntegerLiteral\" | \"DecimalLiteral\" | \"BoolLiteral\" | \"DateLiteral\" | \"YearMonthLiteral\" | \"YearLiteral\" | \"TimeLiteral\" | \"DateTimeLiteral\" | \"DurationLiteral\" | \"URILiteral\" | \"JSONLiteral\"","docsUrl":"/vocabulary"},{"name":"FideIdCalculationOptions","description":"Options for Fide ID calculation helpers.\n\nReserved for forward-compatible toggles without changing function signatures.","type":"FideIdCalculationOptions","entries":{"dangerouslySkipReferenceTypePolicy":{"description":"If true, skip reference-type policy enforcement in calculateFideId.\nDefault is false (policy enforced).","type":"boolean","required":false},"dangerouslySkipReferenceIdentifierPolicy":{"description":"If true, skip referenceIdentifier policy enforcement in calculateFideId.\nDefault is false (policy enforced).","type":"boolean","required":false}}}]}} />

0 commit comments

Comments
 (0)