@contember/cli 1.1.0-alpha.6 → 1.1.0-beta.0

package/src/run.ts

@@ -11,6 +11,7 @@ import {
 	MigrationRebaseCommand,
 	MigrationStatusCommand,
 	ProjectCreateCommand,
+	ProjectGenerateDocumentation,
 	ProjectPrintSchemaCommand,
 	ProjectValidateCommand,
 	ResetPasswordCommand,
@@ -35,6 +36,7 @@ import {
 		['project:create']: () => new ProjectCreateCommand(),
 		['project:validate']: () => new ProjectValidateCommand(),
 		['project:print-schema']: () => new ProjectPrintSchemaCommand(),
+		['project:generate-doc']: () => new ProjectGenerateDocumentation(),
 		['tenant:sign-in']: () => new SignInCommand(),
 		['tenant:create-api-key']: () => new CreateApiKeyCommand(),
 		['tenant:invite']: () => new InviteCommand(),

package/src/tsconfig.json

@@ -1,7 +1,11 @@
 {
 	"extends": "../tsconfig.settings.json",
 	"compilerOptions": {
-		"outDir": "../dist/src"
+		"outDir": "../dist/src",
+		"jsx": "react",
+		"jsxFactory": "h",
+		"lib": ["dom"],
+		"jsxFragmentFactory": "Fragment"
 	},
 	"references": [
 		{

package/src/utils/instance/environment.ts

@@ -2,6 +2,3 @@ export type InstanceApiEnvironment = {
 	baseUrl: string
 }
 
-export const getInstanceFromEnv = (): string | undefined => {
-	return process.env.CONTEMBER_API_URL || process.env.CONTEMBER_INSTANCE
-}

package/src/utils/instance/interactiveUtils.ts

@@ -1,4 +1,4 @@
-import { getInstanceFromEnv, InstanceApiEnvironment } from './environment'
+import { InstanceApiEnvironment } from './environment'
 import { Workspace } from '@contember/cli-common'
 import prompts from 'prompts'
 
@@ -21,7 +21,7 @@ export const interactiveResolveInstanceEnvironmentFromInput = async (
 ): Promise<InstanceApiEnvironment> => {
 	let instanceName =
 		instance ||
-		getInstanceFromEnv() ||
+		workspace.env.apiUrl ||
 		(
 			await prompts({
 				type: 'text',

package/src/utils/project/components/EntityInfo.tsx

@@ -0,0 +1,82 @@
+import { Model, Schema } from '@contember/schema'
+import { ReferencesMap } from '../../schema/collectReferences'
+import { formatEntityAnchor, formatFieldAnchor } from './utils'
+import { SinglePermission } from './SinglePermission'
+import { FieldType } from './FieldType'
+import { FieldPermissions } from './FieldPermissions'
+import { OnDelete } from './OnDelete'
+import { Fragment, h } from 'preact'
+
+interface EntityInfoProps {
+	entity: Model.Entity
+	schema: Schema
+	references: ReferencesMap
+}
+
+export const EntityInfo = ({ entity, schema, references }: EntityInfoProps) => (
+	<div class={'m-4 border border-gray-400 rounded-lg group'}
+		 id={formatEntityAnchor(entity.name)}>
+		<div class={'font-bold text-gray-900 py-2 px-4 border-b border-gray-400 group-target:bg-yellow-100 rounded-t-lg'}>
+			{entity.name}
+		</div>
+		<div class={'px-2 py-2 flex flex-wrap '}>
+			<div>
+				<table>
+					<thead>
+						<tr>
+							<th class={'text-left px-2 text-gray-500 font-normal w-[180px] max-w-[180px]'}>Name</th>
+							<th class={'text-left px-2 text-gray-500 font-normal w-[340px] max-w-[340px]'}>Type</th>
+							{Object.keys(schema.acl.roles).map(role => <th
+								class={'text-left px-2 text-gray-500 font-normal w-[120px] max-w-[120px] text-xs truncate text-sm'}>{role}</th>)}
+						</tr>
+					</thead>
+					<tr>
+						<td></td>
+						<td></td>
+						{Object.values(schema.acl.roles).map(role => <td class={'px-2'}>
+							<SinglePermission value={'D'}
+											  predicate={role.entities[entity.name]?.operations.delete} />
+						</td>)}
+					</tr>
+					{Object.values(entity.fields).map(field => (
+						<tr class={'even:bg-gray-100 target:bg-yellow-100'}
+							id={formatFieldAnchor(entity.name, field.name)}>
+							<td class={'px-2 font-mono truncate  w-[180px] max-w-[180px]'} title={field.name}>
+								{field.name}
+							</td>
+							<td class={'text-gray-800 px-2 font-mono w-[420px] max-w-[420px]'}>
+								<FieldType field={field} />
+							</td>
+							{Object.values(schema.acl.roles).map(role => <td class={'px-2'}>
+								<FieldPermissions field={field.name}
+												  entityPermissions={role.entities[entity.name]} />
+							</td>)}
+						</tr>
+					))}
+
+				</table>
+			</div>
+			<div class={'px-2 py-2 w-1/2'}>
+				<h3 class={'text-lg text-gray-600'}>On delete behaviour:</h3>
+				<p class={'text-gray-500 text-sm'}>
+					(What happens when you attempt to delete entity {entity.name})</p>
+				<div class={'mt-2 text-sm '}>
+					<OnDelete references={references} entity={entity} />
+				</div>
+			</div>
+			{false && <div class={'px-2 py-2 w-1/2'}>
+				<h3 class={'text-lg text-gray-600'}>ACL predicates:</h3>
+				<div class={'mt-2 text-sm '}>
+					{Object.entries(schema.acl.roles).map(([roleName, role]) =>
+						Object.entries(role.entities[entity.name]?.predicates ?? {}).map(([predicateName, predicate]) => (
+							<Fragment>
+								<h4>{roleName}: {predicateName}</h4>
+								<code>{JSON.stringify(predicate)}</code>
+							</Fragment>
+						)),
+					)}
+				</div>
+			</div>}
+		</div>
+	</div>
+)

package/src/utils/project/components/EntityLink.tsx

@@ -0,0 +1,6 @@
+import { h } from 'preact'
+import { formatEntityAnchor } from './utils'
+
+export const EntityLink = ({ entity }: { entity: string }) => (
+	<a href={`#${formatEntityAnchor(entity)}`} class={'text-blue-500 hover:underline'}>{entity}</a>
+)

package/src/utils/project/components/FieldLink.tsx

@@ -0,0 +1,10 @@
+import { Fragment, h } from 'preact'
+import { EntityLink } from './EntityLink'
+import { formatFieldAnchor } from './utils'
+
+export const FieldLink = ({ entity, field, noEntityLabel }: { entity: string; field: string; noEntityLabel?: boolean }) => (
+	<Fragment>
+		{noEntityLabel ? '' : <Fragment><EntityLink entity={entity} />.</Fragment>}
+		<a href={`#${formatFieldAnchor(entity, field)}`} class={'text-blue-500 hover:underline'}>{field}</a>
+	</Fragment>
+)

package/src/utils/project/components/FieldPermissions.tsx

@@ -0,0 +1,14 @@
+import { Fragment, h } from 'preact'
+import { Acl } from '@contember/schema'
+import { SinglePermission } from './SinglePermission'
+
+export const FieldPermissions  = ({ entityPermissions, field }: { entityPermissions?: Acl.EntityPermissions; field: string }) => {
+	const readPermissions = entityPermissions?.operations.read?.[field]
+	const updatePermissions = entityPermissions?.operations.update?.[field]
+	const createPermissions = entityPermissions?.operations.create?.[field]
+	return <Fragment>
+		<SinglePermission value={'C'} predicate={createPermissions} />
+		<SinglePermission value={'R'} predicate={readPermissions} />
+		<SinglePermission value={'U'} predicate={updatePermissions} />
+	</Fragment>
+}

package/src/utils/project/components/FieldType.tsx

@@ -0,0 +1,54 @@
+import { Model } from '@contember/schema'
+import { h, Fragment } from 'preact'
+import { EntityLink } from './EntityLink'
+import { FieldLink } from './FieldLink'
+
+export const FieldType = ({ field }: { field: Model.AnyField }) => {
+	if (field.type === 'ManyHasMany') {
+		return <>
+			<EntityLink entity={field.target}/>[]{' '}
+			<TargetField field={field}/> (m:n)
+		</>
+
+	} else if (field.type === 'OneHasMany') {
+		return <>
+			<EntityLink entity={field.target}/>[]{' '}
+			<TargetField field={field}/> (1:n)
+		</>
+
+	} else if (field.type === 'OneHasOne') {
+		return <>
+			<NullableMark field={field} />
+			<EntityLink entity={field.target}/>{' '}
+			<TargetField field={field}/> (1:1)
+		</>
+
+	} else if (field.type === 'ManyHasOne') {
+		return <>
+			<NullableMark field={field} />
+			<EntityLink entity={field.target}/>{' '}
+			<TargetField field={field}/> (m:1)
+		</>
+
+	} else {
+		return <>
+			<NullableMark field={field} />
+			{field.type}
+		</>
+
+	}
+}
+
+const TargetField = ({ field }: {field: Model.AnyRelation}) => {
+	if ('ownedBy' in field) {
+		return <FieldLink entity={field.target} field={field.ownedBy} noEntityLabel />
+	}
+	if (field.inversedBy) {
+		return <FieldLink entity={field.target} field={field.inversedBy} noEntityLabel />
+	}
+	return null
+}
+
+const NullableMark = (props: { field: Model.NullableRelation | Model.AnyColumn }) => {
+	return props.field.nullable ? <span class={'font-bold color-black'}>? </span> : null
+}

package/src/utils/project/components/OnDelete.tsx

@@ -0,0 +1,72 @@
+import { h, Fragment } from 'preact'
+import { Model } from '@contember/schema'
+import { ReferenceMapEntry, ReferencesMap } from '../../schema/collectReferences'
+import { FieldLink } from './FieldLink'
+import { EntityLink } from './EntityLink'
+
+const sortReferences = (a: ReferenceMapEntry, b: ReferenceMapEntry) =>
+	a.owningRelation.joiningColumn.onDelete.localeCompare(b.owningRelation.joiningColumn.onDelete)
+	|| a.owningEntity.name.localeCompare(b.owningEntity.name)
+	|| a.owningRelation.name.localeCompare(b.owningRelation.name)
+
+export const OnDelete = ({ references, entity, visited = [] }: { references: ReferencesMap; entity: Model.Entity; visited?: Model.Entity[] }) => {
+	const referencedFrom = references[entity.name]
+	if (referencedFrom.length === 0) {
+		if (visited.length !== 0) {
+			return null
+		}
+		return (
+			<span class={'bg-green-200 text-gray-600 p-1 rounded'}>
+				This entity is not referenced from any other entity.
+			</span>
+		)
+	}
+
+	if (visited.includes(entity)) {
+		return (
+			<ul class={'ml-4'}>
+				<li class={'italic'}>(recursion)</li>
+			</ul>
+		)
+	}
+
+	return (
+		<ul class={visited.length > 0 ? 'ml-4' : ''}>
+			{referencedFrom
+				.sort(sortReferences)
+				.map(it => {
+					const inverseDescr = it.targetRelation
+						? <>see <FieldLink entity={entity.name} field={it.targetRelation.name} /></>
+						: 'no inverse side'
+					if (it.owningRelation.joiningColumn.onDelete === 'restrict') {
+						return (
+							<li>
+								<span class={'bg-black text-white px-1'}>Fails</span> when referenced from
+								{' '}<FieldLink entity={it.owningEntity.name} field={it.owningRelation.name} />
+								{' '}({inverseDescr})
+							</li>
+						)
+					}
+					if (it.owningRelation.joiningColumn.onDelete === 'set null') {
+						return (
+							<li>
+								<span class={'bg-blue-400 text-white px-1'}>Sets null</span> at
+								{' '}<FieldLink entity={it.owningEntity.name} field={it.owningRelation.name} />
+								{' '}({inverseDescr})
+							</li>
+						)
+					}
+					if (it.owningRelation.joiningColumn.onDelete === 'cascade') {
+						return (
+							<li>
+								<span class={'bg-red-400 text-white px-1'}>Deletes</span> <EntityLink entity={it.owningEntity.name} />
+								{' '}connected using
+								{' '}<FieldLink entity={it.owningEntity.name} field={it.owningRelation.name} noEntityLabel />
+								{' '}({inverseDescr})
+								<OnDelete entity={it.owningEntity} visited={[...visited, entity]} references={references} />
+							</li>
+						)
+					}
+				})}
+		</ul>)
+}

package/src/utils/project/components/ProjectInfo.tsx

@@ -0,0 +1,48 @@
+import { Schema } from '@contember/schema'
+import { h } from 'preact'
+import { collectReferences } from '../../schema/collectReferences'
+import { EntityLink } from './EntityLink'
+import { EntityInfo } from './EntityInfo'
+
+
+export const ProjectInfo = (props: { schema: Schema; projectName: string }) => {
+	const references = collectReferences(props.schema.model)
+
+	return (
+		<div class={'w-full'}>
+			<div class={'bg-gray-100 p-6 border-b border-gray-400'}>
+				<h1 class={'font-bold text-xl mb-1'}>{props.projectName}</h1>
+				<div class={'flex flex-column gap-4'}>
+					<div>
+						<h2 class={'font-semibold text-gray-500 mb-1'}>Entities</h2>
+						<ul class={'text-sm'}>
+							{Object.values(props.schema.model.entities).map(entity => (
+								<li>
+									<EntityLink entity={entity.name} />
+								</li>
+							))}
+						</ul>
+					</div>
+					<div>
+						<h2 class={'font-semibold text-gray-500 mb-1'}>Enums</h2>
+						<ul class={'text-sm'}>
+							{Object.entries(props.schema.model.enums).map(([name, values]) => (
+								<li class={'mb-2'}>
+									{name} <br />
+									<span class={'text-gray-700 ml-4'}>
+										{values.join(', ')}
+									</span>
+								</li>
+							))}
+						</ul>
+					</div>
+				</div>
+
+
+			</div>
+			{Object.values(props.schema.model.entities).map(entity => (
+				<EntityInfo entity={entity} schema={props.schema} references={references}/>
+			))}
+		</div>
+	)
+}

package/src/utils/project/components/SinglePermission.tsx

@@ -0,0 +1,13 @@
+import { h } from 'preact'
+import { Acl } from '@contember/schema'
+
+export const SinglePermission = ({ predicate, value }: { predicate?: Acl.Predicate; value: string }) => {
+	if (!predicate) {
+		return <span class={'bg-red-500 text-white font-semibold px-0.5'}>{value}</span>
+	}
+	if (predicate === true) {
+		return <span class={'bg-green-600 text-white font-semibold px-0.5'}>{value}</span>
+	}
+	return <span class={'bg-yellow-400 text-black font-semibold px-0.5'} title={predicate}>{value}</span>
+}
+

package/src/utils/project/components/utils.ts

@@ -0,0 +1,3 @@
+export const formatEntityAnchor = (name: string) => `entity-${name}`
+export const formatFieldAnchor = (entity: string, field: string) => `field-${entity}--${field}`
+

package/src/utils/project/projectDescribe.tsx

@@ -0,0 +1,26 @@
+import { Schema } from '@contember/schema'
+import { h } from 'preact'
+import render from 'preact-render-to-string'
+import { ProjectInfo } from './components/ProjectInfo'
+import { readFile } from 'fs/promises'
+
+export const renderProjectInfoHtml = async (schema: Schema, projectName: string) => {
+	const html = render(<ProjectInfo schema={schema} projectName={projectName} />)
+
+	const css = await readFile(__dirname + '/resources/out.css')
+	return `<!DOCTYPE html>
+<html lang="en">
+<head>
+	<meta charset="UTF-8">
+	<meta name="viewport" content="width=device-width, initial-scale=1.0">
+	<style>${css}</style>
+	<title>${projectName}</title>
+</head>
+<body>
+${html}
+</body>
+</html>
+`
+
+}
+

package/src/utils/project/resources/style.css

@@ -0,0 +1,3 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;

package/src/utils/schema/collectReferences.ts

@@ -0,0 +1,40 @@
+import { Model } from '@contember/schema'
+
+export type ReferenceMapEntry = {
+	owningEntity: Model.Entity
+	owningRelation: Model.OneHasOneOwningRelation | Model.ManyHasOneRelation
+	targetEntity: Model.Entity
+	targetRelation: Model.OneHasOneInverseRelation | Model.OneHasManyRelation | null
+}
+export type ReferencesMap = Record<string, ReferenceMapEntry[]>
+
+export const collectReferences = (model: Model.Schema): ReferencesMap => {
+	const entityReferences: ReferencesMap = Object.fromEntries(Object.keys(model.entities).map(it => [it, []]))
+	for (const entity of Object.values(model.entities)) {
+		for (const field of Object.values(entity.fields)) {
+			switch (field.type) {
+				case 'OneHasOne':
+					const targetEntity = model.entities[field.target]
+					if (!('ownedBy' in field)) {
+						entityReferences[field.target].push({
+							owningEntity: entity,
+							owningRelation: field,
+							targetEntity: targetEntity,
+							targetRelation: field.inversedBy ? targetEntity.fields[field.inversedBy] as Model.OneHasOneInverseRelation : null,
+						})
+					}
+					break
+				case 'ManyHasOne':
+					const targetEntity2 = model.entities[field.target]
+					entityReferences[field.target].push({
+						owningEntity: entity,
+						owningRelation: field,
+						targetEntity: targetEntity2,
+						targetRelation: field.inversedBy ? targetEntity2.fields[field.inversedBy] as Model.OneHasManyRelation : null,
+					})
+					break
+			}
+		}
+	}
+	return entityReferences
+}

package/src/utils/tenant.ts

@@ -1,6 +1,7 @@
 import prompts from 'prompts'
 import { GraphQLClient } from 'graphql-request'
 import { InstanceApiEnvironment } from './instance'
+import { Workspace } from '@contember/cli-common'
 
 const validatePassword = (password: string) =>
 	password.length < 6 ? 'Password must contain at least 6 characters' : true
@@ -15,9 +16,9 @@ export const createTenantApiUrl = (url: string) => {
 	return url + '/tenant'
 }
 
-export const interactiveResolveLoginToken = async (instance: InstanceApiEnvironment) => {
-	if (process.env.CONTEMBER_LOGIN_TOKEN) {
-		return process.env.CONTEMBER_LOGIN_TOKEN
+export const interactiveResolveLoginToken = async (workspace: Workspace) => {
+	if (workspace.env.loginToken) {
+		return workspace.env.loginToken
 	}
 	const { loginToken } = await prompts({
 		type: 'text',
@@ -83,12 +84,19 @@ export const interactiveAskForCredentials = async (): Promise<{ email: string; p
 }
 
 export const interactiveResolveApiToken = async ({
+	workspace,
 	instance,
+	apiToken,
 }: {
+	workspace: Workspace
 	instance: InstanceApiEnvironment
+	apiToken?: string
 }): Promise<string> => {
-	if (process.env.CONTEMBER_API_TOKEN) {
-		return process.env.CONTEMBER_API_TOKEN
+	if (apiToken) {
+		return apiToken
+	}
+	if (workspace.env.apiToken) {
+		return workspace.env.apiToken
 	}
 	const { strategy } = await prompts({
 		type: 'select',
@@ -100,7 +108,7 @@ export const interactiveResolveApiToken = async ({
 		],
 	})
 	if (strategy === 'signin') {
-		const loginToken = await interactiveResolveLoginToken(instance)
+		const loginToken = await interactiveResolveLoginToken(workspace)
 		return (await interactiveSignIn({ apiUrl: createTenantApiUrl(instance.baseUrl), loginToken, expiration: 60 * 5 }))
 			.sessionToken
 	}

package/tailwind.config.js

@@ -0,0 +1,7 @@
+module.exports = {
+	content: ['./src/utils/project/components/**/*.tsx'],
+	theme: {
+		extend: {},
+	},
+	plugins: [],
+}

package/dist/src/utils/project.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"project.d.ts","sourceRoot":"","sources":["../../../src/utils/project.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAM1C,eAAO,MAAM,UAAU,YAAmB,OAAO,KAAG,QAAQ,MAAM,CAmBjE,CAAA"}

package/dist/src/utils/project.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"project.js","sourceRoot":"","sources":["../../../src/utils/project.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,iDAAkC;AAClC,+BAA2B;AAC3B,6BAA4B;AAC5B,0DAAoD;AAE7C,MAAM,UAAU,GAAG,KAAK,EAAE,OAAgB,EAAmB,EAAE;IACrE,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC;QACpC,WAAW,EAAE,CAAC,IAAA,WAAI,EAAC,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QAC/C,QAAQ,EAAE,MAAM;QAChB,MAAM,EAAE,IAAI;QACZ,WAAW,EAAE,IAAI;QACjB,KAAK,EAAE,KAAK;QACZ,QAAQ,EAAE,CAAC,kBAAkB,EAAE,OAAO,EAAE,mBAAmB,CAAC;KAC5D,CAAC,CAAA;IACF,MAAM,SAAS,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;IAC9C,MAAM,EAAE,GAAG,IAAI,YAAM,CAAC;QACrB,OAAO,EAAE;YACR,OAAO,EAAE,CAAC,GAAG,CAAC;SACd;KACD,CAAC,CAAA;IACF,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,OAAO,CAAA;IAC9C,gDAAgD;IAChD,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAA;IACtD,OAAO,IAAA,yBAAU,EAAC,WAAW,CAAC,CAAA;AAC/B,CAAC,CAAA;AAnBY,QAAA,UAAU,cAmBtB"}