Skip to main content

Function: isSetupFrameworkAnswersV2()

isSetupFrameworkAnswersV2(document): document is { name: string; primaryDocument: { administeringAuthority?: { contact: string; delegatedRole: string; did?: string; jurisdiction: string; legalName: string; lei?: string; name: string; website?: string }; controlledDocuments: { category: "glossary" | "risk-assessment" | "trust-assurance" | "governance-requirements" | "business-requirements" | "technical-requirements" | "information-trust-requirements" | "inclusion-equitability-accessibility" | "legal-agreements"; description?: string; digest: string; id: string; language: string; title: string; uri: string; version: number }[]; extensions: { allowed: false; paragraphs?: string[] } | { activation: string; allowed: true; approval: string; deactivation: string; notification: string; paragraphs?: string[]; registration: string }; generalRequirements: { id: string; statement: string; topic: "other" | "responsible-use" | "regulatory-compliance" | "code-of-conduct" }[]; governingAuthority: { contact: string; jurisdiction: string; legalName: string; lei?: string; name: string; website?: string }; introduction: { acknowledgements?: string[]; metamodelVersion: "1.0"; paragraphs: string[]; references?: { title: string; uri: string }[] }; localization: { languages: string[]; translationPolicy?: string[]; translations?: { digest: string; language: string; uri: string }[] }; objectives: { id: string; statement: string }[]; principles: { id: string; statement: string }[]; purpose: string; revisions: { procedure: string[]; publicReviewDays?: number }; scope: { governedArtifacts?: string[]; interactions?: string[]; outOfScope?: string[]; stakeholders?: string[] }; terminology: { glossaryDocuments: string[]; paragraphs?: string[]; requirementKeywords: "bcp14"; toipGlossary: string } }; roles: { admissionCriteria: { enforcedBy: "pipeline" | "metadata-policy" | "trust-mark" | "audit"; id: string; statement: string }[]; code: string; name: string }[]; schemaVersion: 2; version: number }

Defined in: packages/contracts/src/setup-answers.ts:226

Tells the two authored shapes apart by the selector.

Parameters​

document​

{ governingAuthority: { contact: string; name: string; }; name: string; roles: object[]; version: number; } | { name: string; primaryDocument: { administeringAuthority?: { contact: string; delegatedRole: string; did?: string; jurisdiction: string; legalName: string; lei?: string; name: string; website?: string; }; controlledDocuments: object[]; extensions: { allowed: false; paragraphs?: string[]; } | { activation: string; allowed: true; approval: string; deactivation: string; notification: string; paragraphs?: string[]; registration: string; }; generalRequirements: object[]; governingAuthority: { contact: string; jurisdiction: string; legalName: string; lei?: string; name: string; website?: string; }; introduction: { acknowledgements?: string[]; metamodelVersion: "1.0"; paragraphs: string[]; references?: object[]; }; localization: { languages: string[]; translationPolicy?: string[]; translations?: object[]; }; objectives: object[]; principles: object[]; purpose: string; revisions: { procedure: string[]; publicReviewDays?: number; }; scope: { governedArtifacts?: string[]; interactions?: string[]; outOfScope?: string[]; stakeholders?: string[]; }; terminology: { glossaryDocuments: string[]; paragraphs?: string[]; requirementKeywords: "bcp14"; toipGlossary: string; }; }; roles: object[]; schemaVersion: 2; version: number; }

A validated authored framework of either version.

Returns​

document is { name: string; primaryDocument: { administeringAuthority?: { contact: string; delegatedRole: string; did?: string; jurisdiction: string; legalName: string; lei?: string; name: string; website?: string }; controlledDocuments: { category: "glossary" | "risk-assessment" | "trust-assurance" | "governance-requirements" | "business-requirements" | "technical-requirements" | "information-trust-requirements" | "inclusion-equitability-accessibility" | "legal-agreements"; description?: string; digest: string; id: string; language: string; title: string; uri: string; version: number }[]; extensions: { allowed: false; paragraphs?: string[] } | { activation: string; allowed: true; approval: string; deactivation: string; notification: string; paragraphs?: string[]; registration: string }; generalRequirements: { id: string; statement: string; topic: "other" | "responsible-use" | "regulatory-compliance" | "code-of-conduct" }[]; governingAuthority: { contact: string; jurisdiction: string; legalName: string; lei?: string; name: string; website?: string }; introduction: { acknowledgements?: string[]; metamodelVersion: "1.0"; paragraphs: string[]; references?: { title: string; uri: string }[] }; localization: { languages: string[]; translationPolicy?: string[]; translations?: { digest: string; language: string; uri: string }[] }; objectives: { id: string; statement: string }[]; principles: { id: string; statement: string }[]; purpose: string; revisions: { procedure: string[]; publicReviewDays?: number }; scope: { governedArtifacts?: string[]; interactions?: string[]; outOfScope?: string[]; stakeholders?: string[] }; terminology: { glossaryDocuments: string[]; paragraphs?: string[]; requirementKeywords: "bcp14"; toipGlossary: string } }; roles: { admissionCriteria: { enforcedBy: "pipeline" | "metadata-policy" | "trust-mark" | "audit"; id: string; statement: string }[]; code: string; name: string }[]; schemaVersion: 2; version: number }

true for version 2.