Skip to content

Commit

Permalink
daml2ts: Enforce that template types are records at the type level (d…
Browse files Browse the repository at this point in the history 
…igital-asset#3960)

The DAML-LF spec says that templates types must be records. Let's enforce
this property in the generated TypeScript on the type level as well.
  • Loading branch information
@hurryabit
hurryabit authored Jan 7, 2020
1 parent bbf3fc6 commit 8cb70df
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 20 deletions.
6 changes: 3 additions & 3 deletions language-support/ts/codegen/tests/ts/daml-json-types/src/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export type TemplateId = {
* Interface for objects representing DAML templates. It is similar to the
* `Template` type class in DAML.
*/
export interface Template<T> extends Serializable<T> {
export interface Template<T extends object> extends Serializable<T> {
templateId: TemplateId;
Archive: Choice<T, {}, {}>;
}
Expand All @@ -41,7 +41,7 @@ export interface Template<T> extends Serializable<T> {
* Interface for objects representing DAML choices. It is similar to the
* `Choice` type class in DAML.
*/
export interface Choice<T, C, R> {
export interface Choice<T extends object, C, R> {
template: () => Template<T>;
argumentDecoder: () => jtv.Decoder<C>;
resultDecoder: () => jtv.Decoder<R>;
Expand All @@ -53,7 +53,7 @@ const registeredTemplates: {[key: string]: Template<object>} = {};
const templateIdToString = ({packageId, moduleName, entityName}: TemplateId) =>
`${packageId}:${moduleName}:${entityName}`;

export const registerTemplate = <T extends {}>(template: Template<T>) => {
export const registerTemplate = <T extends object>(template: Template<T>) => {
const templateId = templateIdToString(template.templateId);
const oldTemplate = registeredTemplates[templateId];
if (oldTemplate === undefined) {
Expand Down
34 changes: 17 additions & 17 deletions language-support/ts/codegen/tests/ts/daml-ledger-fetch/src/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { Choice, ContractId, List, Party, Template, TemplateId, Text, lookupTemp
import * as jtv from '@mojotech/json-type-validation';
import fetch from 'cross-fetch';

export type CreateEvent<T> = {
export type CreateEvent<T extends object> = {
templateId: TemplateId;
contractId: ContractId<T>;
signatories: List<Party>;
Expand All @@ -16,13 +16,13 @@ export type CreateEvent<T> = {
workflowId?: string;
}

export type ArchiveEvent<T> = {
export type ArchiveEvent<T extends object> = {
templateId: TemplateId;
contractId: ContractId<T>;
witnessParties: List<Party>;
}

export type Event<T> =
export type Event<T extends object> =
| { created: CreateEvent<T> }
| { archived: ArchiveEvent<T> }

Expand All @@ -32,7 +32,7 @@ const decodeTemplateId: jtv.Decoder<TemplateId> = jtv.object({
entityName: jtv.string(),
});

const decodeCreateEvent = <T>(template: Template<T>): jtv.Decoder<CreateEvent<T>> => jtv.object({
const decodeCreateEvent = <T extends object>(template: Template<T>): jtv.Decoder<CreateEvent<T>> => jtv.object({
templateId: decodeTemplateId,
contractId: ContractId(template).decoder(),
signatories: List(Party).decoder(),
Expand All @@ -44,18 +44,18 @@ const decodeCreateEvent = <T>(template: Template<T>): jtv.Decoder<CreateEvent<T>
workflowId: jtv.optional(jtv.string()),
});

const decodeCreateEventUnknown: jtv.Decoder<CreateEvent<unknown>> =
const decodeCreateEventUnknown: jtv.Decoder<CreateEvent<object>> =
jtv.valueAt(['templateId'], decodeTemplateId).andThen((templateId) =>
decodeCreateEvent(lookupTemplate(templateId))
);

const decodeArchiveEventUnknown: jtv.Decoder<ArchiveEvent<unknown>> = jtv.object({
const decodeArchiveEventUnknown: jtv.Decoder<ArchiveEvent<object>> = jtv.object({
templateId: decodeTemplateId,
contractId: ContractId({decoder: jtv.unknownJson}).decoder(),
witnessParties: List(Party).decoder(),
});

const decodeEventUnknown: jtv.Decoder<Event<unknown>> = jtv.oneOf<Event<unknown>>(
const decodeEventUnknown: jtv.Decoder<Event<object>> = jtv.oneOf<Event<object>>(
jtv.object({created: decodeCreateEventUnknown}),
jtv.object({archived: decodeArchiveEventUnknown}),
);
Expand Down Expand Up @@ -138,7 +138,7 @@ class Ledger {
* https://github.com/digital-asset/daml/blob/master/docs/source/json-api/search-query-language.rst
* for a description of the query language.
*/
async query<T>(template: Template<T>, query: Query<T>): Promise<CreateEvent<T>[]> {
async query<T extends object>(template: Template<T>, query: Query<T>): Promise<CreateEvent<T>[]> {
const payload = {"%templates": [template.templateId], ...query};
const json = await this.submit('contracts/search', payload);
return jtv.Result.withException(jtv.array(decodeCreateEvent(template)).run(json));
Expand All @@ -147,15 +147,15 @@ class Ledger {
/**
* Retrieve all contracts for a given template.
*/
async fetchAll<T>(template: Template<T>): Promise<CreateEvent<T>[]> {
async fetchAll<T extends object>(template: Template<T>): Promise<CreateEvent<T>[]> {
return this.query(template, {} as Query<T>);
}

/**
* Mimic DAML's `lookupByKey`. The `key` must be a formulation of the
* contract key as a query.
*/
async pseudoLookupByKey<T>(template: Template<T>, key: Query<T>): Promise<CreateEvent<T> | undefined> {
async pseudoLookupByKey<T extends object>(template: Template<T>, key: Query<T>): Promise<CreateEvent<T> | undefined> {
const contracts = await this.query(template, key);
if (contracts.length > 1) {
throw Error("pseudoLookupByKey: query returned multiple contracts");
Expand All @@ -167,7 +167,7 @@ class Ledger {
* Mimic DAML's `fetchByKey`. The `key` must be a formulation of the
* contract key as a query.
*/
async pseudoFetchByKey<T>(template: Template<T>, key: Query<T>): Promise<CreateEvent<T>> {
async pseudoFetchByKey<T extends object>(template: Template<T>, key: Query<T>): Promise<CreateEvent<T>> {
const contract = await this.pseudoLookupByKey(template, key);
if (contract === undefined) {
throw Error("pseudoFetchByKey: query returned no contract");
Expand All @@ -178,7 +178,7 @@ class Ledger {
/**
* Create a contract for a given template.
*/
async create<T>(template: Template<T>, argument: T): Promise<CreateEvent<T>> {
async create<T extends object>(template: Template<T>, argument: T): Promise<CreateEvent<T>> {
const payload = {
templateId: template.templateId,
argument,
Expand All @@ -190,7 +190,7 @@ class Ledger {
/**
* Exercise a choice on a contract.
*/
async exercise<T, C, R>(choice: Choice<T, C, R>, contractId: ContractId<T>, argument: C): Promise<[R , Event<unknown>[]]> {
async exercise<T extends object, C, R>(choice: Choice<T, C, R>, contractId: ContractId<T>, argument: C): Promise<[R , Event<object>[]]> {
const payload = {
templateId: choice.template().templateId,
contractId,
Expand All @@ -199,7 +199,7 @@ class Ledger {
};
const json = await this.submit('command/exercise', payload);
// Decode the server response into a tuple.
const responseDecoder: jtv.Decoder<{exerciseResult: R; contracts: Event<unknown>[]}> = jtv.object({
const responseDecoder: jtv.Decoder<{exerciseResult: R; contracts: Event<object>[]}> = jtv.object({
exerciseResult: choice.resultDecoder(),
contracts: jtv.array(decodeEventUnknown),
});
Expand All @@ -211,22 +211,22 @@ class Ledger {
* Mimic DAML's `exerciseByKey`. The `key` must be a formulation of the
* contract key as a query.
*/
async pseudoExerciseByKey<T, C, R>(choice: Choice<T, C, R>, key: Query<T>, argument: C): Promise<[R, Event<unknown>[]]> {
async pseudoExerciseByKey<T extends object, C, R>(choice: Choice<T, C, R>, key: Query<T>, argument: C): Promise<[R, Event<object>[]]> {
const contract = await this.pseudoFetchByKey(choice.template(), key);
return this.exercise(choice, contract.contractId, argument);
}

/**
* Archive a contract given by its contract id.
*/
async archive<T>(template: Template<T>, contractId: ContractId<T>): Promise<unknown> {
async archive<T extends object>(template: Template<T>, contractId: ContractId<T>): Promise<unknown> {
return this.exercise(template.Archive, contractId, {});
}

/**
* Archive a contract given by its contract id.
*/
async pseudoArchiveByKey<T>(template: Template<T>, key: Query<T>): Promise<unknown> {
async pseudoArchiveByKey<T extends object>(template: Template<T>, key: Query<T>): Promise<unknown> {
return this.pseudoExerciseByKey(template.Archive, key, {});
}
}
Expand Down

0 comments on commit 8cb70df

Please sign in to comment.