make project schema properties optional #133
Conversation
src/lib/encode-converstions.ts
Outdated
| @@ -21,24 +21,25 @@ type ConvertFunction<TSchemaName extends SchemaName> = ( | |||
| > | |||
| ) => CurrentProtoTypes[TSchemaName] | |||
|
|
|||
| /* @ts-ignore TODO: resolve "not assignable to type 'ConvertFunction<"project">" */ | |||
There was a problem hiding this comment.
full output of the error:
error TS2322:
Type '(mapeoDoc: Omit<{ schemaName: "project"; name?: string | undefined; defaultPresets?: { point?: string[] | undefined; area?: string[] | undefined; vertex?: string[] | undefined; line?: string[] | undefined; relation?: string[] | undefined; } | undefined; ... 4 more ...; links: string[]; }, "versionId">) => { ...; }'
is not assignable to type 'ConvertFunction<"project">'.
Call signature return types '{ defaultPresets: { point: Buffer[]; area: Buffer[]; vertex: Buffer[]; line: Buffer[]; relation: Buffer[]; }; name?: string | undefined; docId: string; links: string[]; createdAt: string; updatedAt: string; schemaName: "project"; common: Common_1 | undefined; }'
and 'Project_2' are incompatible.
The types of 'name' are incompatible between these types.
Type 'string | undefined' is not assignable to type 'string'.
Type 'undefined' is not assignable to type 'string'.
There was a problem hiding this comment.
The types from protobuf are quite confusing. Every field in protobuf is optional, but the decoder defaults to settings undefined fields as an empty string / false / 0, unless fields are marked optional.
Fixed this by defining name and defaultPresets as optional in the proto file.
| @@ -21,24 +21,25 @@ type ConvertFunction<TSchemaName extends SchemaName> = ( | |||
| > | |||
| ) => CurrentProtoTypes[TSchemaName] | |||
|
|
|||
| /* @ts-ignore TODO: resolve "not assignable to type 'ConvertFunction<"project">" */ | |||
| export const convertProject: ConvertFunction<'project'> = (mapeoDoc) => { | |||
| return { | |||
| common: convertCommon(mapeoDoc), | |||
| ...mapeoDoc, | |||
There was a problem hiding this comment.
| ...mapeoDoc, | |
| ...mapeoDoc, | |
| name: mapeoDoc.name || '', |
I think that since name is now optional, we need to take that into account here
There was a problem hiding this comment.
I changed the protobuf definition to allow for optional values
There was a problem hiding this comment.
right! forgot about that!
| @@ -21,24 +21,25 @@ type ConvertFunction<TSchemaName extends SchemaName> = ( | |||
| > | |||
| ) => CurrentProtoTypes[TSchemaName] | |||
|
|
|||
| /* @ts-ignore TODO: resolve "not assignable to type 'ConvertFunction<"project">" */ | |||
| export const convertProject: ConvertFunction<'project'> = (mapeoDoc) => { | |||
| return { | |||
| common: convertCommon(mapeoDoc), | |||
| ...mapeoDoc, | |||
There was a problem hiding this comment.
I changed the protobuf definition to allow for optional values
src/lib/encode-converstions.ts
Outdated
| @@ -21,24 +21,25 @@ type ConvertFunction<TSchemaName extends SchemaName> = ( | |||
| > | |||
| ) => CurrentProtoTypes[TSchemaName] | |||
|
|
|||
| /* @ts-ignore TODO: resolve "not assignable to type 'ConvertFunction<"project">" */ | |||
There was a problem hiding this comment.
The types from protobuf are quite confusing. Every field in protobuf is optional, but the decoder defaults to settings undefined fields as an empty string / false / 0, unless fields are marked optional.
Fixed this by defining name and defaultPresets as optional in the proto file.
This removes
nameanddefaultPresetsfrom the required array of the project jsonschemas.There's one type error that I've ts-ignored that I'm not sure how to deal with. See the comment below.