Skip to content
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

Jump to bottom

[patch] move cell value type to a new attribute "cellValueType" in custom function metadata #867

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

[patch] move cell value type to a new attribute "cellValueType" in custom function metadata #867

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6f8ade4
move cell value type to subtype
xai-msft Jun 7, 2024
98d77e9
Merge branch 'master' into CfMetadataCellValueSubtype
xai-msft Jun 18, 2024
48d14f9
rename subtype to cellvaluetype
xai-msft Jun 18, 2024
1fa9919
Merge branch 'OfficeDev:master' into CfMetadataCellValueSubtype
xai-msft Aug 28, 2024
5e147cf
change to first parsing cellValueType. Change fallbacks accordingly
xai-msft Aug 28, 2024
a0cbae4
update formattednumber fallback
xai-msft Aug 29, 2024
22ffcb9
Merge branch 'OfficeDev:master' into CfMetadataCellValueSubtype
xai-msft Sep 26, 2024
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
21 changes: 21 additions & 0 deletions packages/custom-functions-metadata/src/parseTree.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ export interface IFunctionParameter {
name: string;
description?: string;
type: string;
cellValueType?: string;
dimensionality?: string;
optional?: boolean;
repeating?: boolean;
Expand Down Expand Up @@ -159,6 +160,19 @@ const CELLVALUETYPE_MAPPINGS = {
"Excel.ValueTypeNotAvailableCellValue": "unsupported",
};

const CELLVALUETYPE_TO_BASICTYPE_MAPPINGS = {
"cellvalue": "any",
"booleancellvalue": "boolean",
"doublecellvalue": "number",
"entitycellvalue": "any",
"errorcellvalue": "any",
"formattednumbercellvalue": "any",
Copy link
Contributor

@akrantz akrantz Aug 28, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should formattednumbercellvalue map to number?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that makes sense.

"linkedentitycellvalue": "any",
"localimagecellvalue": "any",
"stringcellvalue": "string",
"webimagecellvalue": "any",
};

type CustomFunctionsSchemaDimensionality = "invalid" | "scalar" | "matrix";

/**
Expand Down Expand Up @@ -697,6 +711,13 @@ function getParameters(parameterItem: IGetParametersArguments): IFunctionParamet
type: ptype,
};

// for backward compatibility, we put cell value type in cellValueType instead of type.
if (Object.values(CELLVALUETYPE_MAPPINGS).includes(ptype)) {
// @ts-ignore
pMetadataItem.type = CELLVALUETYPE_TO_BASICTYPE_MAPPINGS[ptype];
pMetadataItem.cellValueType = ptype
}

// Only return dimensionality = matrix. Default assumed scalar
if (pMetadataItem.dimensionality === "scalar") {
delete pMetadataItem.dimensionality;
Expand Down
48 changes: 32 additions & 16 deletions packages/custom-functions-metadata/test/cases/input-parameter-types-cellvalue/expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
"parameters": [
{
"name": "x",
"type": "cellvalue"
"type": "any",
"cellValueType": "cellvalue"
}
],
"result": {}
Expand All @@ -20,7 +21,8 @@
"parameters": [
{
"name": "x",
"type": "booleancellvalue"
"type": "boolean",
"cellValueType": "booleancellvalue"
}
],
"result": {}
Expand All @@ -32,7 +34,8 @@
"parameters": [
{
"name": "x",
"type": "doublecellvalue"
"type": "number",
"cellValueType": "doublecellvalue"
}
],
"result": {}
Expand All @@ -44,7 +47,8 @@
"parameters": [
{
"name": "x",
"type": "entitycellvalue"
"type": "any",
"cellValueType": "entitycellvalue"
}
],
"result": {}
Expand All @@ -56,7 +60,8 @@
"parameters": [
{
"name": "x",
"type": "errorcellvalue"
"type": "any",
"cellValueType": "errorcellvalue"
}
],
"result": {}
Expand All @@ -68,7 +73,8 @@
"parameters": [
{
"name": "x",
"type": "formattednumbercellvalue"
"type": "any",
"cellValueType": "formattednumbercellvalue"
}
],
"result": {}
Expand All @@ -80,7 +86,8 @@
"parameters": [
{
"name": "x",
"type": "linkedentitycellvalue"
"type": "any",
"cellValueType": "linkedentitycellvalue"
}
],
"result": {}
Expand All @@ -92,7 +99,8 @@
"parameters": [
{
"name": "x",
"type": "localimagecellvalue"
"type": "any",
"cellValueType": "localimagecellvalue"
}
],
"result": {}
Expand All @@ -104,7 +112,8 @@
"parameters": [
{
"name": "x",
"type": "stringcellvalue"
"type": "string",
"cellValueType": "stringcellvalue"
}
],
"result": {}
Expand All @@ -116,7 +125,8 @@
"parameters": [
{
"name": "x",
"type": "webimagecellvalue"
"type": "any",
"cellValueType": "webimagecellvalue"
}
],
"result": {}
Expand All @@ -129,7 +139,8 @@
{
"name": "x",
"repeating": true,
"type": "booleancellvalue"
"type": "boolean",
"cellValueType": "booleancellvalue"
}
],
"result": {}
Expand All @@ -142,7 +153,8 @@
{
"dimensionality": "matrix",
"name": "x",
"type": "booleancellvalue"
"type": "boolean",
"cellValueType": "booleancellvalue"
}
],
"result": {}
Expand All @@ -156,7 +168,8 @@
"dimensionality": "matrix",
"name": "x",
"repeating": true,
"type": "booleancellvalue"
"type": "boolean",
"cellValueType": "booleancellvalue"
}
],
"result": {}
Expand All @@ -169,7 +182,8 @@
{
"name": "x",
"repeating": true,
"type": "booleancellvalue"
"type": "boolean",
"cellValueType": "booleancellvalue"
}
],
"result": {}
Expand All @@ -182,7 +196,8 @@
{
"dimensionality": "matrix",
"name": "x",
"type": "booleancellvalue"
"type": "boolean",
"cellValueType": "booleancellvalue"
}
],
"result": {}
Expand All @@ -196,7 +211,8 @@
"dimensionality": "matrix",
"name": "x",
"repeating": true,
"type": "booleancellvalue"
"type": "boolean",
"cellValueType": "booleancellvalue"
}
],
"result": {}
Expand Down