Skip to content

Helper types and predicates for type IDs #37

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
hijarian wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Helper types and predicates for type IDs #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 97 additions & 1 deletion src/generateTypes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,68 @@ export const generateTypes = (config: GenerateTypesConfig = {}) => {
}

if (config.customTypeModels.length > 0) {
const allModelIds: string[] = [];
const modelIdsWithUID: string[] = [];
const modelIdsWithoutUID: string[] = [];
config.customTypeModels.forEach((model) => {
const modelIdString = `"${model.id}"`;
allModelIds.push(modelIdString);
if (Object.assign({}, ...Object.values(model.json)).uid) {
modelIdsWithUID.push(modelIdString);
} else {
modelIdsWithoutUID.push(modelIdString);
}
});

const typeGuard = sourceFile.addFunction({
name: "isTypeCode",
returnType: "typeCode is AllDocumentTypes['type']",
isExported: true,
parameters: [
{
name: "typeCode",
type: "string",
},
],
});
typeGuard.setBodyText((writer) => {
writer.writeLine(
`return [${allModelIds.join(", ")}].includes(typeCode);`,
);
});
const typeGuardWithoutUIDs = sourceFile.addFunction({
name: "isTypeCodeForTypeWithoutUIDs",
returnType: "typeCode is AnyOurDocumentWithoutUID['type']",
isExported: true,
parameters: [
{
name: "typeCode",
type: "string",
},
],
});
typeGuardWithoutUIDs.setBodyText((writer) => {
writer.writeLine(
`return [${modelIdsWithoutUID.join(", ")}].includes(typeCode);`,
);
});
const typeGuardWithUIDs = sourceFile.addFunction({
name: "isTypeCodeForTypeWithUIDs",
returnType: "typeCode is AnyOurDocumentWithUID['type']",
isExported: true,
parameters: [
{
name: "typeCode",
type: "string",
},
],
});
typeGuardWithUIDs.setBodyText((writer) => {
writer.writeLine(
`return [${modelIdsWithUID.join(", ")}].includes(typeCode);`,
);
});

sourceFile.addTypeAlias({
name: "AllDocumentTypes",
type: config.customTypeModels
Expand All @@ -64,6 +126,27 @@ export const generateTypes = (config: GenerateTypesConfig = {}) => {
.join(" | "),
isExported: true,
});

sourceFile.addTypeAlias({
name: "OnlyDocumentsWithUID",
typeParameters: [{ name: "DocumentTypeWithOrWithoutUID" }],
type: "DocumentTypeWithOrWithoutUID extends prismicT.PrismicDocumentWithUID ? DocumentTypeWithOrWithoutUID: never",
});
sourceFile.addTypeAlias({
name: "AnyOurDocumentWithUID",
type: "OnlyDocumentsWithUID<AllDocumentTypes>",
isExported: true,
});
sourceFile.addTypeAlias({
name: "OnlyDocumentsWithoutUID",
typeParameters: [{ name: "DocumentTypeWithOrWithoutUID" }],
type: "DocumentTypeWithOrWithoutUID extends prismicT.PrismicDocumentWithoutUID ? DocumentTypeWithOrWithoutUID: never",
});
sourceFile.addTypeAlias({
name: "AnyOurDocumentWithoutUID",
type: "OnlyDocumentsWithoutUID<AllDocumentTypes>",
isExported: true,
});
}
}

Expand Down Expand Up @@ -130,7 +213,12 @@ export const generateTypes = (config: GenerateTypesConfig = {}) => {
// The Simplify utility type should not
// be exported, but it is included in
// `getExportSymbols()`'s result.
return exportSymbol.getName() !== simplifyTypeAlias.getName();
return (
exportSymbol.getName() !== simplifyTypeAlias.getName() &&
exportSymbol.getName() !== "isTypeCode" &&
exportSymbol.getName() !== "isTypeCodeForTypeWithoutUIDs" &&
exportSymbol.getName() !== "isTypeCodeForTypeWithUIDs"
);
});

contentNamespaceDeclaration.addExportDeclaration({
Expand All @@ -141,6 +229,14 @@ export const generateTypes = (config: GenerateTypesConfig = {}) => {
};
}),
});

contentNamespaceDeclaration.addExportDeclaration({
namedExports: [
{ name: "isTypeCode" },
{ name: "isTypeCodeForTypeWithoutUIDs" },
{ name: "isTypeCodeForTypeWithUIDs" },
],
});
}
}

Expand Down