summaryrefslogtreecommitdiff
path: root/packages/idb-bridge/src/util/extractKey.ts
blob: 2a4ec45b9e8b1a78cab2e03e7dc6cec38af294f6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/*
 Copyright 2017 Jeremy Scheff
 Copyright 2019 Florian Dold

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 or implied. See the License for the specific language governing
 permissions and limitations under the License.
*/

import { IDBKeyPath, IDBValidKey } from "../idbtypes.js";
import { valueToKey } from "./valueToKey.js";

// http://www.w3.org/TR/2015/REC-IndexedDB-20150108/#dfn-steps-for-extracting-a-key-from-a-value-using-a-key-path
/**
 * Algorithm to "extract a key from a value using a key path".
 */
export const extractKey = (keyPath: IDBKeyPath | IDBKeyPath[], value: any) => {
  //console.log(`extracting key ${JSON.stringify(keyPath)} from ${JSON.stringify(value)}`);
  if (Array.isArray(keyPath)) {
    const result: IDBValidKey[] = [];

    for (let item of keyPath) {
      // This doesn't make sense to me based on the spec, but it is needed to pass the W3C KeyPath tests (see same
      // comment in validateKeyPath)
      if (
        item !== undefined &&
        item !== null &&
        typeof item !== "string" &&
        (item as any).toString
      ) {
        item = (item as any).toString();
      }
      result.push(valueToKey(extractKey(item, value)));
    }

    return result;
  }

  if (keyPath === "") {
    return value;
  }

  let remainingKeyPath: string | null = keyPath;
  let object = value;

  while (remainingKeyPath !== null) {
    let identifier;

    const i = remainingKeyPath.indexOf(".");
    if (i >= 0) {
      identifier = remainingKeyPath.slice(0, i);
      remainingKeyPath = remainingKeyPath.slice(i + 1);
    } else {
      identifier = remainingKeyPath;
      remainingKeyPath = null;
    }

    if (object == null || !object.hasOwnProperty(identifier)) {
      return;
    }

    object = object[identifier];
  }

  return object;
};